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.

First Steps

• Installing
• Configuring

Extensions

• plasmapy_sphinx.ext.autodoc
• plasmapy_sphinx.ext.automodsumm
• plasmapy_sphinx.ext.css
• plasmapy_sphinx.ext.directives