more_autodoc.genericalias

Documenter for alias, which usually manifest as type aliases.

New in version 0.6.0.

Enable sphinx_toolbox.more_autodoc.genericalias by adding the following to the extensions variable in your conf.py:

extensions = [
    ...
    'sphinx_toolbox.more_autodoc.genericalias',
    ]

For more information see https://www.sphinx-doc.org/en/master/usage/extensions#third-party-extensions .

Note

sphinx_toolbox.more_autodoc.genericalias is only supported on Python 3.7 and above.

class PrettyGenericAliasDocumenter(directive, name, indent='')

Bases: DataDocumenter

Specialized Documenter subclass for GenericAliases, with prettier output than Sphinx’s one.

add_content(more_content, no_docstring=False)

Add the autodocumenter content.

Parameters:

• more_content (Any)

• no_docstring (bool) – Default False.

add_directive_header(sig)

Add the directive’s header and options to the generated content.

Parameters:

sig (str) – The function/class signature.

classmethod can_document_member(member, membername, isattr, parent)

Called to see if a member can be documented by this documenter.

Parameters:

• member (Any) – The member being checked.

• membername (str) – The name of the member.

• isattr (bool)

• parent (Any) – The parent of the member.

Return type:

bool

objtype = 'genericalias'

Type:    str

priority = -8

Type:    int

setup(app)

Setup sphinx_toolbox.more_autodoc.genericalias.

Parameters:

app (Sphinx) – The Sphinx application.

Return type:

SphinxExtMetadata