IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
pbudzyns
2021-02-01 10:28:01 +01:00
parent 8d380cadc7
commit 35adeeff41
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/usage/extensions/autodoc.rst
View File

@@ -127,6 +127,17 @@ inserting them into the page source under a suitable :rst:dir:`py:module`,
.. automodule:: foo
:no-undoc-members:
.. tip::
You can use autodoc directive options to temporarily override or
extend default options which takes list as an input. For example::
.. autoclass:: Noodle
:members: eat
:private-members: +_spicy, _garlickly
.. versionchanged:: 3.5
The default options can be overridden or extended temporarily.
* Members without docstrings will be left out, unless you give the
``undoc-members`` flag option::