autodoc2.sphinx.utils

Handle sphinx logging.

Module Contents

Functions

load_config	Load the configuration.
warn_sphinx	Log a warning in Sphinx.
get_database	Get the database from the environment.
_warn
get_all_analyser	Get the all analyser from the environment.
nested_parse_generated	This function, nested parses generated content in a directive.

Data

LOGGER

API

autodoc2.sphinx.utils.LOGGER = 'getLogger(...)'

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

Load the configuration.

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

Log a warning in Sphinx.

autodoc2.sphinx.utils.get_database(env: sphinx.environment.BuildEnvironment) → autodoc2.db.Database

Get the database from the environment.

autodoc2.sphinx.utils._warn(msg: str) → None

autodoc2.sphinx.utils.get_all_analyser(env: sphinx.environment.BuildEnvironment) → autodoc2.resolve_all.AllResolver

Get the all analyser from the environment.

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

This function, nested parses generated content in a directive.

All reported warnings are redirected to a specific source document and line.

This is useful for directives that want to parse generated content.