-
-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Closed
Description
Describe the bug
According to the quickstart documentation, quickstart will ask if you want to run autodoc. However, the latest version no longer does this.
To Reproduce
Steps to reproduce the behavior:
sphinx-quickstart
Welcome to the Sphinx 2.1.2 quickstart utility.
Please enter values for the following settings (just press Enter to
accept a default value, if one is given in brackets).
Selected root path: .
You have two options for placing the build directory for Sphinx output.
Either, you use a directory "_build" within the root path, or you separate
"source" and "build" directories within the root path.
> Separate source and build directories (y/n) [n]: y
The project name will occur in several places in the built documentation.
> Project name: Structlog Extensions
> Author name(s): Niels Albers
> Project release []: 0.0.3
If the documents are to be written in a language other than English,
you can select a language here by its language code. Sphinx will then
translate text that it generates into that language.
For a list of supported codes, see
https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-language.
> Project language [en]:
Creating file ./source/conf.py.
Expected behavior
Either: ask for autodoc and configure, as stated in the documentation.
Or: Update the documentation to conform to the new behaviour, and document
how to configure autodoc in the quick start documentation
Environment info
- OS: Linux
- 3.6.0
- Sphinx version: 2.1.2
- Sphinx extensions: sphinx.ext.autodoc
Reactions are currently unavailable