plasmapy_sphinx Documentation

plasmapy_sphinx is a Sphinx extension package that contains custom documentation functionality used to document PlasmaPy’s packages . This package is organized in such a way that users can use all available extensions, or just a selection of desired ones.

Note

plasmapy_sphinx is not currently released in any form and can only be installed directly from its GitHub repository. We do plan to release it to https://pypi.org but there is no scheduled release date at this time.

Additionally, this package currently has no tests covering its functionality.

Installing plasmapy_sphinx

blah

Configuring Your conf.py

blah

plasmapy_sphinx.ext.autodoc

Functions

setup(app)

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

plasmapy_sphinx.ext.automodsumm

Functions

setup(app)

Sphinx setup() function for setting up the automodsumm functionality.

plasmapy_sphinx.ext.css

Functions

add_plasmapy_css(app, config)
setup(app)

plasmapy_sphinx.ext.directives

Functions

setup(app)

A sphinx setup() function for setting up all the functionality defined in plasmapy_sphinx.directives.