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

Close #7490: autosummary: Add `:caption:` option to autosummary directive

Browse Source
This commit is contained in:
Takeshi KOMIYA
2020-04-16 23:04:57 +09:00
parent 5ed890122b
commit dc46897768
5 changed files with 18 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -76,6 +76,12 @@ The :mod:`sphinx.ext.autosummary` extension does this in two parts:
directory. If no argument is given, output is placed in the same directory
as the file that contains the directive.
You can also use ``caption`` option to give a caption to the toctree.
.. versionadded:: 3.1
caption option added.
* If you don't want the :rst:dir:`autosummary` to show function signatures in
the listing, include the ``nosignatures`` option::