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

Remove autosummary_recursive configuration

Browse Source 
Now autosummary directive has :recursive: option to enable the
recursive feature individually.  So the configuration is no longer
needed.
This commit is contained in:
Takeshi KOMIYA
2020-04-21 23:22:05 +09:00
parent b9da9237bc
commit 7671bcc23b
4 changed files with 7 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -13,7 +13,7 @@ those output e.g. by Epydoc and other API doc generation tools. This is
especially useful when your docstrings are long and detailed, and putting each
one of them on a separate page makes them easier to read.
The :mod:`sphinx.ext.autosummary` extension does this in three parts:
The :mod:`sphinx.ext.autosummary` extension does this in two parts:
1. There is an :rst:dir:`autosummary` directive for generating summary listings
that contain links to the documented items, and short summary blurbs
@@ -25,10 +25,6 @@ The :mod:`sphinx.ext.autosummary` extension does this in three parts:
These files by default contain only the corresponding
:mod:`sphinx.ext.autodoc` directive, but can be customized with templates.
3. Optionally, the :confval:`autosummary_recursive` config value can be
used to generate "stub" files of modules and sub-packages for packages
under the :rst:dir:`autosummary` directive.
.. rst:directive:: autosummary
Insert a table that contains links to documented items, and a short summary
@@ -119,9 +115,6 @@ The :mod:`sphinx.ext.autosummary` extension does this in three parts:
sphinx.environment.BuildEnvironment
It is needed to enable :confval:`autosummary_recursive` also to
use this option.
.. versionadded:: 3.1
@@ -180,13 +173,6 @@ also use these config values:
.. versionadded:: 3.0
.. confval:: autosummary_recursive
Boolean that determines whether to add modules and sub-packages
recursively. It is disabled by default.
.. versionadded:: 3.0
.. confval:: autosummary_mock_imports
This value contains a list of modules to be mocked up. See