Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
View this page
Toggle table of contents sidebar

# `autodoc2.sphinx.utils`

## Module Contents

### Functions

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

### Data

`LOGGER` |

### 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

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

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

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

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

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