plasmapy_sphinx.automodsumm.generate

This module contains functionality for auto-generating the stub files related to the automodapi and automodsumm directives.

Classes

AutomodsummEntry(name, path, template, recursive)

A typed version of namedtuple representing an stub file entry for automodsumm.

AutomodsummRenderer(app[, template_dir])

A helper class for retrieving and rendering automodsumm templates when writing stub files.

GenDocsFromAutomodsumm()

Class used for stub file generation from automodapi and automodsumm.

Inheritance diagram of plasmapy_sphinx.automodsumm.generate.AutomodsummEntry, plasmapy_sphinx.automodsumm.generate.AutomodsummRenderer, plasmapy_sphinx.automodsumm.generate.GenDocsFromAutomodsumm