diff options
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>). |