bundle.docs.builder

Attributes

log

Classes

DocsBuilder

Orchestrates Sphinx documentation builds.

Module Contents

bundle.docs.builder.log
class bundle.docs.builder.DocsBuilder(config: bundle.docs.config.DocsConfig)[source]

Orchestrates Sphinx documentation builds.

Creates an ephemeral staging directory with generated conf.py and index.md, then invokes sphinx-build via subprocess.

config
async build() pathlib.Path[source]

Generate Sphinx project files and run the build.

Returns:

Path to the output directory containing built HTML.