autodoc2.sphinx.extension
#
The sphinx extension for the package.
Module Contents#
Classes#
Cache for the environment. |
Functions#
Entry point for sphinx. |
|
The primary sphinx call back event for sphinx. |
|
Run autodoc for a single package. |
|
Download a git repository to the given folder. |
API#
- autodoc2.sphinx.extension.setup(app: sphinx.application.Sphinx) dict[str, str | bool] [source]#
Entry point for sphinx.
- autodoc2.sphinx.extension.run_autodoc(app: sphinx.application.Sphinx) None [source]#
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 [source]#
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 [source]#
Download a git repository to the given folder.