compile_docs.sh¶
Documentation site generator using MkDocs Material.
Overview¶
Builds the static documentation website from the Markdown files in the doc/ directory using mkdocs-material. Replaces the previous pasdoc-based HTML generation.
Dependencies¶
- Python 3
mkdocs-material(installed automatically if missing)
Behavior¶
- Checks whether
mkdocsis available on thePATH. - If not found, installs
mkdocs-materialvia pip. - Runs
mkdocs build --strictto generate the static site. - Output is written to the
site/directory at the project root.
Configuration¶
The site is configured by mkdocs.yml in the project root. The navigation structure mirrors the doc/ directory hierarchy.