template_python.models

Pydantic models used across the codebase.

Classes

SphinxConfig(**data)

Configuration for Sphinx documentation generation.

class template_python.models.SphinxConfig(**data)

Configuration for Sphinx documentation generation.

repo_name: str

version: str

author: str

extensions: list[str]

html_theme: str

property project_name: str

Generate a human-readable project name from the repository name.

property package_name: str

Generate a valid Python package name from the repository name.

property copyright: str

Generate a copyright string using the current year and author.

property rst_prolog_keys: list[str]

Get the keys for RST substitutions.

property rst_prolog_values: list[str]

Get the values for RST substitutions.

model_config: ClassVar[ConfigDict] = {}

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