Scanpydoc

A series of Sphinx extensions to get maintainable 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:

dict[str, Any]

Returns:

Metadata for this extension.

Included extensions

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.
release_notes	A release notes directive.
theme	A widescreen extension for Sphinx Book Theme.