diff options
Diffstat (limited to 'sphinx/ext/autosummary/generate.py')
| -rw-r--r-- | sphinx/ext/autosummary/generate.py | 21 |
1 files changed, 8 insertions, 13 deletions
diff --git a/sphinx/ext/autosummary/generate.py b/sphinx/ext/autosummary/generate.py index a08e45fa6..1866b6c52 100644 --- a/sphinx/ext/autosummary/generate.py +++ b/sphinx/ext/autosummary/generate.py @@ -1,20 +1,15 @@ -""" - sphinx.ext.autosummary.generate - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - Usable as a library or script to generate automatic RST source files for - items referred to in autosummary:: directives. +"""Generates reST source files for autosummary. - Each generated RST file contains a single auto*:: directive which - extracts the docstring of the referred item. +Usable as a library or script to generate automatic RST source files for +items referred to in autosummary:: directives. - Example Makefile rule:: +Each generated RST file contains a single auto*:: directive which +extracts the docstring of the referred item. - generate: - sphinx-autogen -o source/generated source/*.rst +Example Makefile rule:: - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. + generate: + sphinx-autogen -o source/generated source/*.rst """ import argparse |