summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2021-01-02 12:12:33 +0900
committerGitHub <noreply@github.com>2021-01-02 12:12:33 +0900
commit99c580d563321be1a6b6bf3f77e939d4ee58e7fc (patch)
treea70a431c66dd4038055c7d95beee62be94ccc699
parent7ecf6b88aa5ddaed552527d2ef60f1bd35e98ddc (diff)
parent1f020196a792ee85421f2fb949d9bddfbd27ff61 (diff)
downloadsphinx-git-99c580d563321be1a6b6bf3f77e939d4ee58e7fc.tar.gz
Merge pull request #8640 from xuhdev/recursive
DOC: `modules` are only available when `recursive` is on
-rw-r--r--doc/usage/extensions/autosummary.rst2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/usage/extensions/autosummary.rst b/doc/usage/extensions/autosummary.rst
index d50abd89e..03ea7548e 100644
--- a/doc/usage/extensions/autosummary.rst
+++ b/doc/usage/extensions/autosummary.rst
@@ -304,7 +304,7 @@ The following variables available in the templates:
.. data:: modules
List containing names of "public" modules in the package. Only available for
- modules that are packages.
+ modules that are packages and the ``recursive`` option is on.
.. versionadded:: 3.1