summaryrefslogtreecommitdiff
path: root/sphinx/ext/autodoc/directive.py
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2017-12-17 01:31:32 +0900
committerTakeshi KOMIYA <i.tkomiya@gmail.com>2017-12-17 02:13:36 +0900
commit1ab0d96a5f8b3ef1f07598a80aaf6c1f9eb5076c (patch)
tree7f10b9b50002b58cbdd00ca9795f5002fdd6a6e7 /sphinx/ext/autodoc/directive.py
parent299b11f26f98b1f6bf61602ff9955a12b7d1593e (diff)
downloadsphinx-git-1ab0d96a5f8b3ef1f07598a80aaf6c1f9eb5076c.tar.gz
Update docstrings
Diffstat (limited to 'sphinx/ext/autodoc/directive.py')
-rw-r--r--sphinx/ext/autodoc/directive.py4
1 files changed, 4 insertions, 0 deletions
diff --git a/sphinx/ext/autodoc/directive.py b/sphinx/ext/autodoc/directive.py
index 78593d27c..077ee5dfd 100644
--- a/sphinx/ext/autodoc/directive.py
+++ b/sphinx/ext/autodoc/directive.py
@@ -53,6 +53,8 @@ class Options(dict):
class DocumenterBridge(object):
+ """A parameters container for Documenters."""
+
def __init__(self, env, reporter, options, lineno):
# type: (BuildEnvironment, Reporter, Options, int) -> None
self.env = env
@@ -70,6 +72,7 @@ class DocumenterBridge(object):
def process_documenter_options(documenter, config, options):
# type: (Type[Documenter], Config, Dict) -> Options
+ """Recognize options of Documenter from user input."""
for name in AUTODOC_DEFAULT_OPTIONS:
if name not in documenter.option_spec:
continue
@@ -83,6 +86,7 @@ def process_documenter_options(documenter, config, options):
def parse_generated_content(state, content, documenter):
# type: (State, StringList, Documenter) -> List[nodes.Node]
+ """Parse a generated content by Documenter."""
with switch_source_input(state, content):
if documenter.titles_allowed:
node = nodes.section()