diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2022-03-19 22:58:15 +0900 |
|---|---|---|
| committer | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2022-03-19 22:58:15 +0900 |
| commit | aa1bc83c2ac9357b39048b555c3fdb0efff3449c (patch) | |
| tree | c1149670ca18b5f9820505322d5b0a5832395ea4 /sphinx/ext/autodoc/__init__.py | |
| parent | 759a526b12213c59d6ae4c8f66682f4328b764f4 (diff) | |
| parent | 017ef6118b4fe588140266ad6ff2393cbddd9137 (diff) | |
| download | sphinx-git-aa1bc83c2ac9357b39048b555c3fdb0efff3449c.tar.gz | |
Merge branch '4.x'
Diffstat (limited to 'sphinx/ext/autodoc/__init__.py')
| -rw-r--r-- | sphinx/ext/autodoc/__init__.py | 13 |
1 files changed, 4 insertions, 9 deletions
diff --git a/sphinx/ext/autodoc/__init__.py b/sphinx/ext/autodoc/__init__.py index 54ca64ea2..980329e6d 100644 --- a/sphinx/ext/autodoc/__init__.py +++ b/sphinx/ext/autodoc/__init__.py @@ -1,13 +1,8 @@ -""" - sphinx.ext.autodoc - ~~~~~~~~~~~~~~~~~~ - - Automatically insert docstrings for functions, classes or whole modules into - the doctree, thus avoiding duplication between docstrings and documentation - for those who like elaborate docstrings. +"""Extension to create automatic documentation from code docstrings. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +Automatically insert docstrings for functions, classes or whole modules into +the doctree, thus avoiding duplication between docstrings and documentation +for those who like elaborate docstrings. """ import re |