sphinx.ext.autosummary.Autosummary

class documentation

class Autosummary(SphinxDirective): (source)

View In Hierarchy

Pretty table containing short signatures and summaries of functions etc. autosummary can also optionally generate a hidden toctree:: node.

Method create_documenter Get an autodoc.Documenter class suitable for documenting the given object.
Method get_items Try to import the given names, and return a list of ``[(name, signature, summary_string, real_name), ...]``.
Method get_table Generate a proper list of table nodes for autosummary:: directive.
Method import_by_name Undocumented
Method run Undocumented
Class Variable final_argument_whitespace Undocumented
Class Variable has_content Undocumented
Class Variable option_spec Undocumented
Class Variable optional_arguments Undocumented
Class Variable required_arguments Undocumented
Instance Variable bridge Undocumented

Inherited from SphinxDirective:

Method get_location Get current location info for logging.
Method get_source_info Get source and line number.
Method set_source_info Set source and line number to the node.
Property config Reference to the :class:`.Config` object.
Property env Reference to the :class:`.BuildEnvironment` object.
def create_documenter(self, app, obj, parent, full_name): (source)

Get an autodoc.Documenter class suitable for documenting the given object. Wraps get_documenter and is meant as a hook for extensions.

Parameters
app:SphinxUndocumented
obj:AnyUndocumented
parent:AnyUndocumented
full_name:strUndocumented
Returns
DocumenterUndocumented
def get_items(self, names): (source)

Try to import the given names, and return a list of ``[(name, signature, summary_string, real_name), ...]``.

Parameters
names:list[str]Undocumented
Returns
list[tuple[str, str, str, str]]Undocumented
def get_table(self, items): (source)

Generate a proper list of table nodes for autosummary:: directive. *items* is a list produced by :meth:`get_items`.

Parameters
items:list[tuple[str, str, str, str]]Undocumented
Returns
list[Node]Undocumented
def import_by_name(self, name, prefixes): (source)

Undocumented

Parameters
name:strUndocumented
prefixes:list[str|None]Undocumented
Returns
tuple[str, Any, Any, str]Undocumented
def run(self): (source)

Undocumented

Returns
list[Node]Undocumented
final_argument_whitespace: bool = (source)

Undocumented

has_content: bool = (source)

Undocumented

option_spec: OptionSpec = (source)

Undocumented

optional_arguments: int = (source)

Undocumented

required_arguments: int = (source)

Undocumented

bridge = (source)

Undocumented