Installation

The generator requires Python 3.11 or newer and no third-party Python packages.

Optional Mermaid diagram rendering needs a separate Node.js/browser toolchain. The recommended Mermaid builder container provides it. Default builds need no extra dependencies and display diagram source as code.

Build the documentation#

Run the build from the repository root:

python3 build.py

The command validates the source and writes the static site to dist/.

Preview locally#

Start Python's static file server after building:

python3 -m http.server --directory dist 8000

Open http://localhost:8000/en/ in a browser. The root URL redirects to the default language; /pl/ contains the partial Polish example.

The generated files are disposable. Always make content changes in manual/en/ or manual/pl/, then build again.