diff options
| author | woutdenolf <woutdenolf@users.sf.net> | 2019-06-02 16:26:40 +0200 |
|---|---|---|
| committer | woutdenolf <woutdenolf@users.sf.net> | 2019-06-02 16:26:40 +0200 |
| commit | ec8656bd27e24697a5ce4aa8a0ddebd705768f26 (patch) | |
| tree | 741de29f28ca8b77c7a12ca7a64a1cfab8e5c8ce /doc/usage/extensions | |
| parent | 4fb58b2146dd6daea2dd326b577a7dd1ee6f43e2 (diff) | |
| download | sphinx-git-ec8656bd27e24697a5ce4aa8a0ddebd705768f26.tar.gz | |
[autosummary] remove recursion limit and module/package separation
Diffstat (limited to 'doc/usage/extensions')
| -rw-r--r-- | doc/usage/extensions/autosummary.rst | 23 |
1 files changed, 6 insertions, 17 deletions
diff --git a/doc/usage/extensions/autosummary.rst b/doc/usage/extensions/autosummary.rst index 0bdc4e640..316ffcb9d 100644 --- a/doc/usage/extensions/autosummary.rst +++ b/doc/usage/extensions/autosummary.rst @@ -25,7 +25,7 @@ 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, :confval:`autosummary_depth_limit` config value can be +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. @@ -148,16 +148,12 @@ also use these config values: The new files will be placed in the directories specified in the ``:toctree:`` options of the directives. -.. confval:: autosummary_depth_limit +.. confval:: autosummary_recursive - Integer that determines the maximal depth (starting from root) when adding - modules and sub-packages of packages. - - - ``autosummary_depth_limit = -1``: no limit - - ``autosummary_depth_limit = 0``: disable adding sub-packages (default) - - ``autosummary_depth_limit > 0``: limited depth starting from root + Boolean that determines whether to add modules and sub-packages + recursively. It is disabled by default. - .. versionadded:: 2.1 + .. versionadded:: 2.2 .. confval:: autosummary_mock_imports @@ -272,14 +268,7 @@ The following variables available in the templates: List containing names of "public" modules in the package. Only available for modules that are packages. - .. versionadded:: 2.1 - -.. data:: packages - - List containing names of "public" sub-packages in the package. Only available - for modules that are packages. - - .. versionadded:: 2.1 + .. versionadded:: 2.2 Additionally, the following filters are available |