t3hn3rd
466173613f
continuous-integration/drone/push Build is failing
Replace placeholder content in doc/compat/, doc/lvglh/, and doc/toolchain/ with comprehensive documentation derived from the source files. - compat: document Wasuro WASM VM compatibility shims - lvglh: document LVGL v9.2.2 configuration, fonts, and patches - toolchain: document all 13 build pipeline scripts
24 lines
728 B
Markdown
24 lines
728 B
Markdown
# 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
|
|
|
|
1. Checks whether `mkdocs` is available on the `PATH`.
|
|
2. If not found, installs `mkdocs-material` via pip.
|
|
3. Runs `mkdocs build --strict` to generate the static site.
|
|
4. 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.
|