summaryrefslogtreecommitdiff
path: root/sphinx/ext/apidoc.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/apidoc.py
parent759a526b12213c59d6ae4c8f66682f4328b764f4 (diff)
parent017ef6118b4fe588140266ad6ff2393cbddd9137 (diff)
downloadsphinx-git-aa1bc83c2ac9357b39048b555c3fdb0efff3449c.tar.gz
Merge branch '4.x'
Diffstat (limited to 'sphinx/ext/apidoc.py')
-rw-r--r--sphinx/ext/apidoc.py19
1 files changed, 7 insertions, 12 deletions
diff --git a/sphinx/ext/apidoc.py b/sphinx/ext/apidoc.py
index 07339d6e6..68afc83b8 100644
--- a/sphinx/ext/apidoc.py
+++ b/sphinx/ext/apidoc.py
@@ -1,17 +1,12 @@
-"""
- sphinx.ext.apidoc
- ~~~~~~~~~~~~~~~~~
-
- Parses a directory tree looking for Python modules and packages and creates
- ReST files appropriately to create code documentation with Sphinx. It also
- creates a modules index (named modules.<suffix>).
+"""Creates reST files corresponding to Python modules for code documentation.
- This is derived from the "sphinx-autopackage" script, which is:
- Copyright 2008 Société des arts technologiques (SAT),
- https://sat.qc.ca/
+Parses a directory tree looking for Python modules and packages and creates
+ReST files appropriately to create code documentation with Sphinx. It also
+creates a modules index (named modules.<suffix>).
- :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
- :license: BSD, see LICENSE for details.
+This is derived from the "sphinx-autopackage" script, which is:
+Copyright 2008 Société des arts technologiques (SAT),
+https://sat.qc.ca/
"""
import argparse