sphinx_automagicdoc package

A plugin to automagically create autodoc-based API documentation files on the fly

sphinx_automagicdoc.setup(app: Sphinx)

sphinx_automagicdoc.entrypoint module

sphinx_automagicdoc.entrypoint.config_intialized(app: Sphinx, config: Config)

sphinx_automagicdoc.entrypoint.process_text(data: str) → str

sphinx_automagicdoc.entrypoint.setup(app: Sphinx)

sphinx_automagicdoc.mock module

sphinx_automagicdoc.mock.mock(original_function, module=None)

sphinx_automagicdoc.rst_preparation module

sphinx_automagicdoc.rst_preparation.prepare_jinja_template(template: str) → Template

sphinx_automagicdoc.rst_preparation.prepare_rst_template_content(module: Module, module_hierarchy: List[Module]) → Dict[str, Union[str, List[str]]]

sphinx_automagicdoc.mock_filesystem module

sphinx_automagicdoc.mock_filesystem.docutils_io_opem(*args, **kwargs)

sphinx_automagicdoc.mock_filesystem.find_virtual(path: str) → Optional[str]

sphinx_automagicdoc.mock_filesystem.os_access(*args, **kwargs)

sphinx_automagicdoc.mock_filesystem.os_stat(*args, **kwargs)

sphinx_automagicdoc.mock_filesystem.os_walk(*args, **kwargs)

sphinx_automagicdoc.mock_filesystem.shutil_copyfile(*args, **kwargs)

sphinx_automagicdoc.mock_filesystem.startstrip(search: str, pattern: str) → Optional[str]

sphinx_automagicdoc.model module

class sphinx_automagicdoc.model.Module(module_str, is_package, has_submodules, parent_str)

Bases: tuple

has_submodules: bool

Alias for field number 2

is_package: bool

Alias for field number 1

module_str: str

Alias for field number 0

parent_str: str

Alias for field number 3

sphinx_automagicdoc.module_scanner module

sphinx_automagicdoc.module_scanner.get_module_hierarchy(name: Union[str, module], ignore: Optional[List[str]] = None) → Iterable[Module]

sphinx_automagicdoc.util module

sphinx_automagicdoc.util.escape(text: str) → str

sphinx_automagicdoc.util.euline(string: str, char: str = '=')

sphinx_automagicdoc.util.uline(string: str, char: str = '=')