quickstart does not ask for "autodoc" anymore

205 views
Skip to first unread message

c.b...@posteo.jp

unread,
Mar 2, 2022, 4:10:40 AM3/2/22
to Sphinx users
I found a blog/tutorial from 2017.

https://eikonomega.medium.com/getting-started-with-sphinx-autodoc-part-1-2cebbbca5365

The sphinx-quickstart there asks an autodoc related question:
"autodoc: automatically insert docstrings from modules (y/n):"

Am I correct that this is gone in the current stable release of sphinx?
And what is the design thinking behind it? What changed in the years?

c.b...@posteo.jp

unread,
Mar 2, 2022, 4:19:23 AM3/2/22
to Sphinx users
Am 02.03.2022 10:10 schrieb c.b...@posteo.jp:
> Am I correct that this is gone in the current stable release of
> sphinx? And what is the design thinking behind it? What changed in the
> years?

I was looking into the current/stable (?) official docu
https://www.sphinx-doc.org/en/1.5.1/tutorial.html

That tutorial also mention an "autodoc" question from
"sphinx-quickstart".

I updated my Sphinx via pip to version 4.4.0. I can definitely say that
it doesn't ask my a question related to autodoc.

Here is the complete output of my sphinx-quickstart

Python 3.9.2 (default, Feb 28 2021, 17:03:44)
[GCC 10.2.1 20210110] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import sphinx
>>> sphinx.__version__
'4.4.0'
>>> exit()
 user   main  ~  tab-cloud  _transfer  killme  sphinx-quickstart
Welcome to the Sphinx 4.4.0 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: n
> Author name(s): n
> Project release []: 0

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 /home/user/tab-cloud/_transfer/killme/source/conf.py.
Creating file /home/user/tab-cloud/_transfer/killme/source/index.rst.
Creating file /home/user/tab-cloud/_transfer/killme/Makefile.
Creating file /home/user/tab-cloud/_transfer/killme/make.bat.

Finished: An initial directory structure has been created.

You should now populate your master file
/home/user/tab-cloud/_transfer/killme/source/index.rst and create other
documentation
source files. Use the Makefile to build the docs, like so:
make builder
where "builder" is one of the supported builders, e.g. html, latex or
linkcheck.

c.b...@posteo.jp

unread,
Mar 2, 2022, 5:05:36 AM3/2/22
to Sphinx users
Am 02.03.2022 10:19 schrieb c.b...@posteo.jp:
> I was looking into the current/stable (?) official docu
> https://www.sphinx-doc.org/en/1.5.1/tutorial.html

I have to correct myself. This is an outdated version. (See #10229 and
#10230) of the documentation.

The current stable docu does not say anything about "autodoc" in context
of "sphinx-quickstart".

Stephen Finucane

unread,
Mar 8, 2022, 7:25:10 AM3/8/22
to sphinx...@googlegroups.com
This was an intentional change to make the sphinx-quickstart application less
verbose and therefore easier to use. You can still achieve this by passing the
'--ext-autodoc' option.

Stephen
Reply all
Reply to author
Forward
0 new messages