-
Notifications
You must be signed in to change notification settings - Fork 107
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
Enabeling "sphinx.ext.autodoc" is missing from sphinx-config.rst #7
Comments
@tcmetzger I believe that this is covered by selecting
under See the Sphinx Quickstart section of the tutorial. |
The problem is that sphinx-quickstart no longer asks for extensions they can only be added from the command line or edited manually. See Issue: sphinx-doc/sphinx#4148 and PR: sphinx-doc/sphinx#6066 Here is what sphinx-quick start asked me today:
@sglvladi, It would be great if you could update your tutorial! |
As far as I can see, the tutorial does not include instructions on how to enable the autodoc extension for Sphinx in the first place. The file
conf.py
has to includeextensions = ['sphinx.ext.autodoc']
(see https://www.sphinx-doc.org/en/master/usage/quickstart.html#autodoc) to correctly render the autodoc directives.I would suggest adding this information to
sphinx-config.rst
. I'd be happy to create a pull request to fix this.The text was updated successfully, but these errors were encountered: