Project Manual
Contents

Commands

The project deliberately exposes only a few commands.

Show the version#

python3 build.py --version

Build the documentation#

python3 build.py

Build for a forge project path:

python3 build.py --base-path /example-project/

Select a bundled theme:

python3 build.py --theme paper

Build an offline ZIP that opens without a server:

python3 build.py \
  --offline-archive artifacts/manual-site-offline.zip

Run the tests#

python3 -m unittest discover -s tests -v

Serve generated files#

python3 -m http.server --directory dist 8000

Use Make helpers#

Show all helper targets:

make help

Generate or preview the bundled example:

make bundle
make bundle THEME=paper
make offline-bundle
make preview PORT=8000
make example PORT=8080

Generate or run external documentation with Podman:

make bundle-container SOURCE=/absolute/path/to/docs
make run-container SOURCE=/absolute/path/to/docs PORT=8080

See the Make helper guide for variables and complete workflows.