sphinx.ext.autosummary.Autosummary

class documentation

class Autosummary(SphinxDirective):

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 `.Config` object.
Property	`env`	Reference to the `.BuildEnvironment` object.

def create_documenter(self, app, obj, parent, full_name):

Get an autodoc.Documenter class suitable for documenting the given object.

Wraps get_documenter and is meant as a hook for extensions.

def get_items(self, names):

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

def get_table(self, items):

Generate a proper list of table nodes for autosummary:: directive.

items is a list produced by get_items.

Parameters
items:`List[Tuple[str, str, str, str]]`	Undocumented
Returns
`List[Node]`	Undocumented

def import_by_name(self, name, prefixes):

Undocumented

def run(self):

Undocumented

Returns
`List[Node]`	Undocumented

final_argument_whitespace: bool =

Undocumented

has_content: bool =

Undocumented

option_spec: OptionSpec =

Undocumented

optional_arguments: int =

Undocumented

required_arguments: int =

Undocumented

bridge =

Undocumented