sphinx.ext.autosummary.generate

module documentation

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
Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Variable logger Undocumented
Class ​Autosummary​Entry Undocumented
Class ​Autosummary​Renderer A helper class for rendering.
Class ​Dummy​Application Dummy Application class for sphinx-autogen command.
Class ​Module​Scanner Undocumented
Function ​_simple​_info Undocumented
Function ​_simple​_warn Undocumented
Function ​_underline 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
logger =

Undocumented

def _simple_info(msg):

Undocumented

Parameters
msg:strUndocumented
def _simple_warn(msg):

Undocumented

Parameters
msg:strUndocumented
def _underline(title, line='='):

Undocumented

Parameters
title:strUndocumented
line:strUndocumented
Returns
strUndocumented
def find_autosummary_in_docstring(name, module=None, filename=None):

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

See find_autosummary_in_lines.

Parameters
name:strUndocumented
module:strUndocumented
filename:strUndocumented
Returns
List[AutosummaryEntry]Undocumented
def find_autosummary_in_files(filenames):

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):

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:strUndocumented
filename:strUndocumented
Returns
List[AutosummaryEntry]Undocumented
def generate_autosummary_content(name, obj, parent, template, template_name, imported_members, app, recursive, context, modname=None, qualname=None):

Undocumented

Parameters
name:strUndocumented
obj:AnyUndocumented
parent:AnyUndocumented
template:AutosummaryRendererUndocumented
template​_name:strUndocumented
imported​_members:boolUndocumented
app:AnyUndocumented
recursive:boolUndocumented
context:DictUndocumented
modname:strUndocumented
qualname:strUndocumented
Returns
strUndocumented
def generate_autosummary_docs(sources, output_dir=None, suffix='.rst', base_path=None, builder=None, template_dir=None, imported_members=False, app=None, overwrite=True, encoding='utf-8'):

Undocumented

Parameters
sources:List[str]Undocumented
output​_dir:strUndocumented
suffix:strUndocumented
base​_path:strUndocumented
builder:BuilderUndocumented
template​_dir:strUndocumented
imported​_members:boolUndocumented
app:AnyUndocumented
overwrite:boolUndocumented
encoding:strUndocumented
def get_parser():

Undocumented

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

Undocumented

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

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):

Undocumented

Parameters
app:AnyUndocumented