betty.documentation module

Provide the Documentation API.

class betty.documentation.DocumentationServer[source]

Bases: Server

Serve the documentation site.

Parameters:
__init__(cache_directory_path: pathlib._local.Path, *, localizer: betty.locale.Localizer)[source]
Parameters:
classmethod label() betty.locale.Str[source]

Get the server’s human-readable label.

Return type:

betty.locale.Str

property public_url: str

The server’s public URL.

async start() None[source]

Start the server.

Return type:

None

async stop() None[source]

Stop the server.

Return type:

None