Manual configuration¶
Manual profiles under configs/manual/ define ordered handbook content. The repository-level
configs/manual/sources.toml pins remote sources and describes official-manual page ranges.
Profile schema¶
ManualProfile
pydantic-model
¶
documents contains one or more entries in output order. include_frontmatter inserts the
configured frontmatter for the profile language.
Document variants¶
OfficialDocument
pydantic-model
¶
KtaneContentDocument
pydantic-model
¶
KtaneContentAppendix
pydantic-model
¶
LocalDocument
pydantic-model
¶
All effective documents and optional frontmatter must use one language. A relative local path is
resolved from the checkout root and must end in .html. Its local dependencies must stay beside or
below the document.
Source catalog¶
ManualSources
pydantic-model
¶
The catalog schema version is 1. Its KtaneContent commit is a full 40-character Git commit. The
catalog also defines the official manual URLs and page maps, catalog URL, and language-specific
frontmatter.
Provider-owned formats stay external
The catalog records URLs and pins, but GPTNT does not redefine the remote repositories or PDF formats behind them.
Rule-seed support¶
Each suite selects manual_rule_seed, which defaults to 1. A non-default seed changes the
solution rules for KtaneContent modules that declare rule-seed support. GPTNT compiles the manual
for the selected profile-and-seed pair before a run.
Use Manuals and rule seeds for the rules boundary, Prepare manuals to edit and compile a profile, and the manual file reference for persisted inputs and cache outputs.