Scanpydoc

A series of Sphinx extensions to get easy to maintain, numpydoc style documentation.

This module is also an extension itself which simply sets up all included extensions.

setup(app)

Set up all included extensions!

Parameters
app : Sphinx

Sphinx app to set this extension up for

Return type

{str: Any}Dict[str, Any]

Returns

Metadata for this extension.

Included extensions

autosummary_generate_imported

Generate autosummary docs for imported members.

definition_list_typed_field

Prettier function parameter documentation.

elegant_typehints

Format typehints elegantly and and fix automatically created links.

rtd_github_links

GitHub URLs for class and method pages

theme

A widescreen extension for Read the Docs Sphinx Theme.