sphinx.ext.autosummary.generate

module documentation
(source)

Generates reST source files for autosummary. Usable as a library or script to generate automatic RST source files for items referred to in autosummary:: directives. Each generated RST file contains a single auto*:: directive which extracts the docstring of the referred item. Example Makefile rule:: generate: sphinx-autogen -o source/generated source/*.rst

Class AutosummaryEntry Undocumented
Class AutosummaryRenderer A helper class for rendering.
Class DummyApplication Dummy Application class for sphinx-autogen command.
Class ModuleScanner Undocumented
Function find_autosummary_in_docstring Find out what items are documented in the given object's docstring.
Function find_autosummary_in_files Find out what items are documented in source/*.rst.
Function find_autosummary_in_lines Find out what items appear in autosummary:: directives in the given lines.
Function generate_autosummary_content Undocumented
Function generate_autosummary_docs Undocumented
Function get_parser Undocumented
Function main Undocumented
Function members_of Get the members of ``obj``, possibly ignoring the ``__all__`` module attribute
Function setup_documenters Undocumented
Variable logger Undocumented
Function _underline Undocumented
def find_autosummary_in_docstring(name, filename=None): (source)

Find out what items are documented in the given object's docstring. See `find_autosummary_in_lines`.

Parameters
name:strUndocumented
filename:str|NoneUndocumented
Returns
list[AutosummaryEntry]Undocumented
def find_autosummary_in_files(filenames): (source)

Find out what items are documented in source/*.rst. See `find_autosummary_in_lines`.

Parameters
filenames:list[str]Undocumented
Returns
list[AutosummaryEntry]Undocumented
def find_autosummary_in_lines(lines, module=None, filename=None): (source)

Find out what items appear in autosummary:: directives in the given lines. Returns a list of (name, toctree, template) where *name* is a name of an object and *toctree* the :toctree: path of the corresponding autosummary directive (relative to the root of the file name), and *template* the value of the :template: option. *toctree* and *template* ``None`` if the directive does not have the corresponding options set.

Parameters
lines:list[str]Undocumented
module:str|NoneUndocumented
filename:str|NoneUndocumented
Returns
list[AutosummaryEntry]Undocumented
def generate_autosummary_content(name, obj, parent, template, template_name, imported_members, app, recursive, context, modname=None, qualname=None): (source)

Undocumented

Parameters
name:strUndocumented
obj:AnyUndocumented
parent:AnyUndocumented
template:AutosummaryRendererUndocumented
template_name:strUndocumented
imported_members:boolUndocumented
app:AnyUndocumented
recursive:boolUndocumented
context:dictUndocumented
modname:str|NoneUndocumented
qualname:str|NoneUndocumented
Returns
strUndocumented
def generate_autosummary_docs(sources, output_dir=None, suffix='.rst', base_path=None, imported_members=False, app=None, overwrite=True, encoding='utf-8'): (source)

Undocumented

Parameters
sources:list[str]Undocumented
output_dir:str|NoneUndocumented
suffix:strUndocumented
base_path:str|NoneUndocumented
imported_members:boolUndocumented
app:AnyUndocumented
overwrite:boolUndocumented
encoding:strUndocumented
def get_parser(): (source)

Undocumented

Returns
argparse.ArgumentParserUndocumented
def main(argv=sys.argv[1:]): (source)

Undocumented

Parameters
argv:list[str]Undocumented
def members_of(obj, conf): (source)

Get the members of ``obj``, possibly ignoring the ``__all__`` module attribute Follows the ``conf.autosummary_ignore_module_all`` setting.

Parameters
obj:AnyUndocumented
conf:ConfigUndocumented
Returns
Sequence[str]Undocumented
def setup_documenters(app): (source)

Undocumented

Parameters
app:AnyUndocumented
logger = (source)

Undocumented

def _underline(title, line='='): (source)

Undocumented

Parameters
title:strUndocumented
line:strUndocumented
Returns
strUndocumented