diff options
Diffstat (limited to 'sphinx/ext/apidoc.py')
| -rw-r--r-- | sphinx/ext/apidoc.py | 19 |
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 |