GreatDocs.build()

Build the documentation site.

Usage

Source

GreatDocs.build(
    watch=False,
    refresh=True,
)

Generates API reference pages followed by quarto render. By default, re-discovers package exports and updates the API reference configuration before building.

Note

In practice, you would normally use the great-docs build CLI command rather than calling this method directly. See the CLI reference for details.

Parameters

watch: bool = False

If True, watch for changes and rebuild automatically.

refresh: bool = True

If True (default), re-discover package exports and update API reference config before building. Set to False for faster rebuilds when your package API hasn’t changed.

Examples

Build the documentation (with API refresh):

from great_docs import GreatDocs

docs = GreatDocs()
docs.build()

Build with watch mode:

docs.build(watch=True)

Quick rebuild without API refresh:

docs.build(refresh=False)