You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
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
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
Error logs / results
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
The text was updated successfully, but these errors were encountered: