autodoc2.sphinx.extension

The sphinx extension for the package.

Module Contents

Classes

EnvCache

Cache for the environment.

Functions

setup	Entry point for sphinx.
run_autodoc	The primary sphinx call back event for sphinx.
run_autodoc_package	Run autodoc for a single package.
get_git_clone	Download a git repository to the given folder.

API

autodoc2.sphinx.extension.setup(app: sphinx.application.Sphinx) → dict[str, str | bool]

Entry point for sphinx.

autodoc2.sphinx.extension.run_autodoc(app: sphinx.application.Sphinx) → None

The primary sphinx call back event for sphinx.

autodoc2.sphinx.extension.run_autodoc_package(app: sphinx.application.Sphinx, config: autodoc2.config.Config, pkg_index: int) → str | None

Run autodoc for a single package.

Returns:

The top level module name, relative to the api directory.

autodoc2.sphinx.extension.get_git_clone(app: sphinx.application.Sphinx, url: str, branch_tag: str, config: autodoc2.config.Config) → None | pathlib.Path

Download a git repository to the given folder.

class autodoc2.sphinx.extension.EnvCache

Bases: typing.TypedDict

Cache for the environment.

Initialization

Initialize self. See help(type(self)) for accurate signature.

hash: str = None

root_module: str = None