ProjectModel

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

Bases: BaseModel

Model for the project table in the documenteer.toml file.

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]] = {'base_url': FieldInfo(annotation=Union[Annotated[Url, UrlConstraints(max_length=2083, allowed_schemes=['http', 'https'], host_required=None, default_host=None, default_port=None, default_path=None)], NoneType], required=False, default=None, description="Canonical URL of the site's root page."), 'copyright': FieldInfo(annotation=str, required=False, default='', description="Copyright statement, without a 'copyright' prefix word."), 'github_default_branch': FieldInfo(annotation=str, required=False, default='main', description="The project's default development branch on GitHub."), 'github_url': FieldInfo(annotation=Union[Annotated[Url, UrlConstraints(max_length=2083, allowed_schemes=['http', 'https'], host_required=None, default_host=None, default_port=None, default_path=None)], NoneType], required=False, default=None, description="The URL of the project's GitHub repository."), 'openapi': FieldInfo(annotation=Union[OpenApiDocsModel, NoneType], required=False, default=None), 'python': FieldInfo(annotation=Union[PythonPackageModel, NoneType], required=False, default=None), 'title': FieldInfo(annotation=str, required=True, description='Name of the project, used as titles throughout the documentation site.'), 'version': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='Version string.')}

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.