`autodoc2.sphinx.utils`#

Module Contents#

Functions#

`load_config`
`warn_sphinx`
`get_database`
`_warn`
`get_all_analyser`
`nested_parse_generated`

Data#

API#

autodoc2.sphinx.utils.LOGGER = None#

autodoc2.sphinx.utils.load_config(app: sphinx.application.Sphinx, *, overrides: None | dict[str, Any] = None, location: None | docutils.nodes.Element = None) → autodoc2.config.Config[source]#

autodoc2.sphinx.utils.warn_sphinx(msg: str, subtype: autodoc2.utils.WarningSubtypes, location: None | docutils.nodes.Element = None) → None[source]#

autodoc2.sphinx.utils.get_database(env: sphinx.environment.BuildEnvironment) → autodoc2.db.Database[source]#

autodoc2.sphinx.utils._warn(msg: str) → None[source]#

autodoc2.sphinx.utils.get_all_analyser(env: sphinx.environment.BuildEnvironment) → autodoc2.resolve_all.AllResolver[source]#

autodoc2.sphinx.utils.nested_parse_generated(state: docutils.parsers.rst.states.RSTStateMachine, content: list[str], source: str, line: int, *, match_titles: bool = False, base: docutils.nodes.Element | None = None) → docutils.nodes.Element[source]#