Build documentation¶

Prerequisites¶

Install redsun with development dependencies.

Build with Zensical¶

From the project root:

uv run tox -e docs

This builds the site, then runs scripts/check_xrefs.py, which reports every cross-reference that resolves to nothing. zensical build alone passes with such references, so prefer the tox environment:

uv run zensical build          # build only, no cross-reference check

The site lands in site/. Serve it locally with:

uv run zensical serve

The server listens on http://localhost:8000 and rebuilds on every change.

Troubleshooting¶

Missing dependencies¶

uv sync --group docs

uv run tox -e docs installs them itself, from uv.lock.

Port already in use¶

Pick another port:

uv run zensical serve --dev-addr localhost:8080

Next steps¶

• Run tests
• Read about the container architecture