1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
|
:py:mod:`autodoc2.sphinx.extension`
===================================
.. py:module:: autodoc2.sphinx.extension
.. autodoc2-docstring:: autodoc2.sphinx.extension
:allowtitles:
Module Contents
---------------
Classes
~~~~~~~
.. list-table::
:class: autosummary longtable
:align: left
* - :py:obj:`EnvCache <autodoc2.sphinx.extension.EnvCache>`
- .. autodoc2-docstring:: autodoc2.sphinx.extension.EnvCache
:summary:
Functions
~~~~~~~~~
.. list-table::
:class: autosummary longtable
:align: left
* - :py:obj:`setup <autodoc2.sphinx.extension.setup>`
- .. autodoc2-docstring:: autodoc2.sphinx.extension.setup
:summary:
* - :py:obj:`run_autodoc <autodoc2.sphinx.extension.run_autodoc>`
- .. autodoc2-docstring:: autodoc2.sphinx.extension.run_autodoc
:summary:
* - :py:obj:`run_autodoc_package <autodoc2.sphinx.extension.run_autodoc_package>`
- .. autodoc2-docstring:: autodoc2.sphinx.extension.run_autodoc_package
:summary:
* - :py:obj:`get_git_clone <autodoc2.sphinx.extension.get_git_clone>`
- .. autodoc2-docstring:: autodoc2.sphinx.extension.get_git_clone
:summary:
API
~~~
.. py:function:: setup(app: sphinx.application.Sphinx) -> dict[str, str | bool]
:canonical: autodoc2.sphinx.extension.setup
.. autodoc2-docstring:: autodoc2.sphinx.extension.setup
.. py:function:: run_autodoc(app: sphinx.application.Sphinx) -> None
:canonical: autodoc2.sphinx.extension.run_autodoc
.. autodoc2-docstring:: autodoc2.sphinx.extension.run_autodoc
.. py:function:: run_autodoc_package(app: sphinx.application.Sphinx, config: autodoc2.config.Config, pkg_index: int) -> str | None
:canonical: autodoc2.sphinx.extension.run_autodoc_package
.. autodoc2-docstring:: autodoc2.sphinx.extension.run_autodoc_package
.. py:function:: get_git_clone(app: sphinx.application.Sphinx, url: str, branch_tag: str, config: autodoc2.config.Config) -> None | pathlib.Path
:canonical: autodoc2.sphinx.extension.get_git_clone
.. autodoc2-docstring:: autodoc2.sphinx.extension.get_git_clone
.. py:class:: EnvCache()
:canonical: autodoc2.sphinx.extension.EnvCache
Bases: :py:obj:`typing.TypedDict`
.. autodoc2-docstring:: autodoc2.sphinx.extension.EnvCache
.. rubric:: Initialization
.. autodoc2-docstring:: autodoc2.sphinx.extension.EnvCache.__init__
.. py:attribute:: hash
:canonical: autodoc2.sphinx.extension.EnvCache.hash
:type: str
:value: None
.. autodoc2-docstring:: autodoc2.sphinx.extension.EnvCache.hash
.. py:attribute:: root_module
:canonical: autodoc2.sphinx.extension.EnvCache.root_module
:type: str
:value: None
.. autodoc2-docstring:: autodoc2.sphinx.extension.EnvCache.root_module
|