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: minor doc clarifications

Browse Source
This commit is contained in:
Pauli Virtanen
2011-06-29 21:27:43 +02:00
parent bb51a20745
commit e1be6ef8f8
1 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
doc/ext/autosummary.rst
View File

@@ -19,19 +19,21 @@ The :mod:`sphinx.ext.autosummary` extension does this in two parts:
contain links to the documented items, and short summary blurbs extracted
from their docstrings.
2. The convenience script :program:`sphinx-autogen` or the new
2. Optionally, the convenience script :program:`sphinx-autogen` or the new
:confval:`autosummary_generate` config value can be used to generate short
"stub" files for the entries listed in the :rst:dir:`autosummary` directives.
These by default contain only the corresponding :mod:`sphinx.ext.autodoc`
directive.
These files by default contain only the corresponding :mod:`sphinx.ext.autodoc`
directive, but can be customized with templates.
.. rst:directive:: autosummary
Insert a table that contains links to documented items, and a short summary
blurb (the first sentence of the docstring) for each of them. The
:rst:dir:`autosummary` directive can also optionally serve as a :rst:dir:`toctree`
entry for the included items.
blurb (the first sentence of the docstring) for each of them.
The :rst:dir:`autosummary` directive can also optionally serve as a
:rst:dir:`toctree` entry for the included items. Optionally, stub
``.rst`` files for these items can also be automatically generated.
For example, ::