Subject: sphinx-quickstart invocation doc seems incorrect.
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]
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.
sphinx-quickstart
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
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
https://hub.docker.com/r/zimmerman/phaseflow-fenics/
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,
Fixed by #4621
Thank you for reporting!
Most helpful comment
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,