cpdocs API documentation
Project documentation Docs

render_html_site Python

Defined in html.py

def cpdocs.rendering.html.render_html_site(graph: cpdocs.model.ApiGraph, *, output_directory: pathlib.Path, project_docs_url: str, copyright_text: str, introduction_file: pathlib.Path | None = None, theme: cpdocs.config.SiteTheme | None = None) -> None

Render one API version to a standalone HTML site in `output_directory`.

The site is rendered into a fresh sibling directory and moved into place only when complete, so a failed render leaves the previous site untouched. The directory being replaced is deleted as itself: a symbolic link there is refused rather than followed.

Available in feature sets