plasmapy_sphinx.autodoc

This sub-package contains functionality that extends sphinx.ext.autodoc.

This functionality was highly influenced by and adapted from sphinx.ext.autodoc and sphinx_automodapi.automodapi.

Defined Directives

A directive (ref) is a generic block of explicit markup. Along with roles, it is one of the extension mechanisms of reST and, thus, Sphinx.

Directive	Description
automodapi .. automodapi:: modname	An autodoc directive that auto-generates documentation for a given module modname (i.e. sub-package or .py file) by inspecting and summarizing the object contained in the module.

Defined Configuration Values

Configuration values are variables that can be defined in the conf.py file to control the default behavior Sphinx and Sphinx extension packages like plasmapy_sphinx.

Configuration Value	Description
automodapi_default_toctree_dir	Default directory for placing stub files requested by the automodapi directive.
automodapi_group_order	The order automodapi displays its group automodsumm tables.
automodapi_groups_with_inheritance_diagrams	Define groups that should include inheritance diagrams.
automodapi_include_inheritance_diagram	Control if automodapi should display inheritance diagrams by default.

API

Sub-Packages & Modules

automodapi

This module contains the functionality used to define the automodapi directive and its supporting configuration values.

Functions

setup(app)

Sphinx setup() function for setting up all of the plasmapy_sphinx.autodoc functionality, this includes plasmapy_sphinx.automodsumm functionality.