SphinxModel

class documenteer.conf._toml.SphinxModel(**data)

Bases: BaseModel

Model for Sphinx configurations in documenteer.toml.

Parameters:

data (Any)

Attributes Summary

model_computed_fields	A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
model_config	Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
model_fields	Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

Attributes Documentation

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[Dict[str, FieldInfo]] = {'disable_primary_sidebars': FieldInfo(annotation=Union[List[str], NoneType], required=False, default=None, description="Pages that should not have a primary sidebar. Can be the page's path (without extension) or a glob of pages. By default the homepage and change logs do not have a primary sidebar."), 'exclude': FieldInfo(annotation=List[str], required=False, default_factory=list, description='List of paths to exclude from being considered as Sphinx content sources.'), 'extensions': FieldInfo(annotation=List[str], required=False, default_factory=list, description='Additional Sphinx extension.'), 'intersphinx': FieldInfo(annotation=IntersphinxModel, required=False, default_factory=<lambda>), 'linkcheck': FieldInfo(annotation=LinkCheckModel, required=False, default_factory=<lambda>), 'nitpick_ignore': FieldInfo(annotation=List[Tuple[str, str]], required=False, default_factory=list, description='Errors to ignore. First item is the type (like a role or directive) and the second is the target (like the argument to the role).'), 'nitpick_ignore_regex': FieldInfo(annotation=List[Tuple[str, str]], required=False, default_factory=list, description='Same as ``nitpick_ignore``, but both type and target are interpreted as regular expressions.'), 'nitpicky': FieldInfo(annotation=bool, required=False, default=False, description='Escalate warnings to build errors.'), 'python_api_dir': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='Directory path where the Python API reference documentation is created.'), 'redirects': FieldInfo(annotation=Dict[str, str], required=False, default_factory=dict, description='Mapping of paths to redirect to other paths. These redirects are implemented with sphinx-rediraffe.'), 'rst_epilog_file': FieldInfo(annotation=Union[Annotated[Path, PathType], NoneType], required=False, default=None, description='Path to a reStructuredText file that is added to every source file. Use this file to define common links and substitutions.'), 'theme': FieldInfo(annotation=ThemeModel, required=False, default_factory=<lambda>)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.