diff options
| author | Adam Turner <9087854+aa-turner@users.noreply.github.com> | 2022-02-20 02:57:02 +0000 |
|---|---|---|
| committer | Adam Turner <9087854+aa-turner@users.noreply.github.com> | 2022-02-20 02:57:02 +0000 |
| commit | b691ebcc3e440a678cd28432fed7279fa647e9cd (patch) | |
| tree | faa2103fb21a8e51ea0dfe735c43bd4ed1071e13 /sphinx/ext/apidoc.py | |
| parent | 5694e0ce60316b9cb9709d147e1a699ea9bde6da (diff) | |
| download | sphinx-git-b691ebcc3e440a678cd28432fed7279fa647e9cd.tar.gz | |
Conform to PEP 257 summary line conventions
Diffstat (limited to 'sphinx/ext/apidoc.py')
| -rw-r--r-- | sphinx/ext/apidoc.py | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/sphinx/ext/apidoc.py b/sphinx/ext/apidoc.py index 6b93656f4..378eca221 100644 --- a/sphinx/ext/apidoc.py +++ b/sphinx/ext/apidoc.py @@ -1,4 +1,6 @@ -"""Parses a directory tree looking for Python modules and packages and creates +"""Creates reST files corresponding to Python modules for code documentation. + +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>). |