IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update docstrings

Browse Source
This commit is contained in:
Takeshi KOMIYA 2017-12-17 01:31:32 +09:00
parent 299b11f26f
commit 1ab0d96a5f
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
sphinx/ext/autodoc/directive.py
View File

@ -53,6 +53,8 @@ class Options(dict):
class DocumenterBridge(object): class DocumenterBridge(object):
"""A parameters container for Documenters."""
def __init__(self, env, reporter, options, lineno): def __init__(self, env, reporter, options, lineno):
# type: (BuildEnvironment, Reporter, Options, int) -> None # type: (BuildEnvironment, Reporter, Options, int) -> None
self.env = env self.env = env
@ -70,6 +72,7 @@ class DocumenterBridge(object):
def process_documenter_options(documenter, config, options): def process_documenter_options(documenter, config, options):
# type: (Type[Documenter], Config, Dict) -> Options # type: (Type[Documenter], Config, Dict) -> Options
"""Recognize options of Documenter from user input."""
for name in AUTODOC_DEFAULT_OPTIONS: for name in AUTODOC_DEFAULT_OPTIONS:
if name not in documenter.option_spec: if name not in documenter.option_spec:
continue continue
@ -83,6 +86,7 @@ def process_documenter_options(documenter, config, options):
def parse_generated_content(state, content, documenter): def parse_generated_content(state, content, documenter):
# type: (State, StringList, Documenter) -> List[nodes.Node] # type: (State, StringList, Documenter) -> List[nodes.Node]
"""Parse a generated content by Documenter."""
with switch_source_input(state, content): with switch_source_input(state, content):
if documenter.titles_allowed: if documenter.titles_allowed:
node = nodes.section() node = nodes.section()