dev.docs.models

dev.docs.models#

Models.

Submodules#

Package Contents#

Classes#

Build

Docs.

API#

class dev.docs.models.Build(
/,
**data: typing.Any,
)#

Bases: pydantic.BaseModel

Docs.

Initialization

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

force_mode: dev.docs.types.BuildMode | None#

None

Force building documentation in a certain mode.

nb_execution_excludepatterns: dev.docs.models.types.NbExecutionExcludePatterns#

[‘notebooks/e230920*.ipynb’, ‘notebooks/get_mae.ipynb’]

List of directories relative to docs to exclude executing notebooks in.

nb_execution_mode: dev.docs.types.NbExecutionMode#

‘cache’

Notebook execution mode.

https://myst-nb.readthedocs.io/en/stable/computation/execute.html#notebook-execution-modes

skip_autodoc: dev.docs.models.types.SkipAutodoc#

False

Skip the potentially slow process of autodoc generation.

skip_autodoc_post_parse: bool#

False

Skip the potentially slow process of autodoc post parsing.

Contents