mafw.devtools.documentation.server

Local documentation server management for MAFw.

This module provides the ServerStatusEnum, helper functions, and orchestration logic for managing a python -m http.server subprocess used to serve locally built versioned documentation.

Module Attributes

SERVER_DEFAULT_DIRECTORY	Default directory served by the local documentation server.
SERVER_METADATA_FILENAME	Filename for server metadata stored inside the served directory.

Functions

get_server_status(directory)	Determine the current server status from metadata and process/HTTP checks.
server_start_impl(address, port, directory, ...)	Implementation for starting a local documentation server.
server_stop_by_metadata(directory, ...)	Stop the server based on metadata found under a served directory.

mafw.devtools.documentation.server.get_server_status(directory: Path) → Tuple[ServerStatusEnum, dict[str, Any] | None]

Determine the current server status from metadata and process/HTTP checks.

mafw.devtools.documentation.server.server_start_impl(address: str, port: int, directory: Path, log_file: Path, force_restart: bool) → None

Implementation for starting a local documentation server.

mafw.devtools.documentation.server.server_stop_by_metadata(directory: Path, require_metadata: bool) → None

Stop the server based on metadata found under a served directory.

mafw.devtools.documentation.server.SERVER_DEFAULT_DIRECTORY = PosixPath('docs/build')

Default directory served by the local documentation server.

mafw.devtools.documentation.server.SERVER_METADATA_FILENAME = '.multiversion-doc-server.json'

Filename for server metadata stored inside the served directory.