bundle.docs.cli

bundle docs CLI

bundle docs build [–source .] [–output docs/_build/html] [–package src/bundle] [–theme furo] bundle docs serve [–output docs/_build/html] [–port 8000] bundle docs init [–source .] bundle docs copyright update –year 2026 [–source .] bundle docs copyright check [–source .] bundle docs copyright add –year 2026 –owner Name [–source .]

Attributes

log

Functions

docs()	Build and serve Sphinx documentation.
build(source, output, package, theme)	Build HTML documentation from docstrings and READMEs.
serve(output, port)	Serve built documentation locally for preview.
init(source)	Initialize persistent Sphinx configuration files in a project.
copyright()	Manage copyright headers in source files.
check(source)	Report which files have or lack a copyright header.
update(source, year)	Update the copyright year in all files that already have a header.
add(source, year, owner)	Add a copyright + license header to files that lack one.

Module Contents

bundle.docs.cli.log

async bundle.docs.cli.docs()

Build and serve Sphinx documentation.

async bundle.docs.cli.build(source: str, output: str, package: str | None, theme: str)

Build HTML documentation from docstrings and READMEs.

async bundle.docs.cli.serve(output: str, port: int)

Serve built documentation locally for preview.

async bundle.docs.cli.init(source: str)

Initialize persistent Sphinx configuration files in a project.

async bundle.docs.cli.copyright()

Manage copyright headers in source files.

async bundle.docs.cli.check(source: str)

Report which files have or lack a copyright header.

async bundle.docs.cli.update(source: str, year: int)

Update the copyright year in all files that already have a header.

async bundle.docs.cli.add(source: str, year: int, owner: str)

Add a copyright + license header to files that lack one.