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

autosummary: Add :recursive: option to autosummary directive

Browse Source
This commit is contained in:
Takeshi KOMIYA
2020-02-23 01:51:43 +09:00
parent 665458561f
commit 476b73b6ca
8 changed files with 58 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
doc/usage/extensions/autosummary.rst
View File

@@ -104,6 +104,20 @@ The :mod:`sphinx.ext.autosummary` extension does this in three parts:
.. versionadded:: 1.0
* You can specify the ``recursive`` option to generate documents for
modules and sub-packages recursively. It defaults to disabled.
For example, ::
.. autosummary::
:recursive:
sphinx.environment.BuildEnvironment
It is needed to enable :confval:`autosummary_recursive` also to
use this option.
.. versionadded:: 3.1
:program:`sphinx-autogen` -- generate autodoc stub pages
--------------------------------------------------------