Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

sphinx-quickstart: error: the following arguments are required: PROJECT_DIR #4617

Closed
agzimmerman opened this issue Feb 14, 2018 · 2 comments
Closed

Comments

@agzimmerman
Copy link

Subject: sphinx-quickstart invocation doc seems incorrect.

Problem

I am trying to use Sphinx (version 1.7) for the first time. I am following the First steps guide and the ReadTheDocs Getting Started guide, both of which say to enter only
sphinx-quickstart

But this returns

usage: sphinx-quickstart [OPTIONS] <PROJECT_DIR>
sphinx-quickstart: error: the following arguments are required: PROJECT_DIR

The docs say "If you omit projectdir, files are generated into current directory by default."

Side note: As an amateur Python developer using Sphinx for the first time, my first assumption would have been that "PROJECT_DIR" would refer to the root directory of my Python project.

Procedure to reproduce the problem

sphinx-quickstart

Error logs / results

usage: sphinx-quickstart [OPTIONS] <PROJECT_DIR>
sphinx-quickstart: error: the following arguments are required: PROJECT_DIR

http://www.sphinx-doc.org/en/stable/invocation.html

Expected results

sphinx-quickstart should execute, and begin prompting the user for manual inputs related to various options. See http://www.sphinx-doc.org/en/stable/invocation.html

Reproducible project / your project

https://hub.docker.com/r/zimmerman/phaseflow-fenics/

Environment info

  • OS: Linux 818a60beed73 4.9.60-linuxkit-aufs Global citations #1 SMP Mon Nov 6 16:00:12 UTC 2017 x86_64 x86_64 x86_64 GNU/Linux
  • Python version: Python 3.5.2 (default, Sep 14 2017, 22:51:06) [GCC 5.4.0 20160609] on linux
  • Sphinx version: 1.7.0
@tk0miya
Copy link
Member

tk0miya commented Feb 14, 2018

Sorry for inconvenience. It's a bug of quickstart command.
I just made a bug fix #4621.

Please give path as an argument until fixed.
Thanks,

@tk0miya tk0miya added this to the 1.7.1 milestone Feb 14, 2018
tk0miya added a commit that referenced this issue Feb 17, 2018
Fix #4617: quickstart: PROJECT_DIR argument is required
@tk0miya
Copy link
Member

tk0miya commented Feb 17, 2018

Fixed by #4621
Thank you for reporting!

@tk0miya tk0miya closed this as completed Feb 17, 2018
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 19, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants