Module

cli.templates.docs.template

Documentation site template.

Seeds a docs site with top‑level sections (Getting Started, Guides, API).

Functions

_load_template_file
Load a static page stub bundled with this template.
1 str
def _load_template_file(relative_path: str) -> str

Load a static page stub bundled with this template.

Parameters 1

Name Type Default Description
relative_path str

Path inside this template'spages/directory.

Returns

str

The raw file contents to write.

_create_docs_template
Construct the documentation site template definition.
0 SiteTemplate
def _create_docs_template() -> SiteTemplate

Construct the documentation site template definition.

Returns

SiteTemplate

A :class:SiteTemplatewith common docs scaffolding.