summaryrefslogtreecommitdiff
path: root/sphinx/ext/autosummary/generate.py
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2022-03-19 22:58:15 +0900
committerTakeshi KOMIYA <i.tkomiya@gmail.com>2022-03-19 22:58:15 +0900
commitaa1bc83c2ac9357b39048b555c3fdb0efff3449c (patch)
treec1149670ca18b5f9820505322d5b0a5832395ea4 /sphinx/ext/autosummary/generate.py
parent759a526b12213c59d6ae4c8f66682f4328b764f4 (diff)
parent017ef6118b4fe588140266ad6ff2393cbddd9137 (diff)
downloadsphinx-git-aa1bc83c2ac9357b39048b555c3fdb0efff3449c.tar.gz
Merge branch '4.x'
Diffstat (limited to 'sphinx/ext/autosummary/generate.py')
-rw-r--r--sphinx/ext/autosummary/generate.py21
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