The documentation roughly attempts to follow Diátaxis.
Prose conventions: docs/STYLE.md.
You can view the moccasin documentation here.
To build the documentation:
-
Follow the
Installing for local developmentinstructions in CONTRIBUTING.md. -
Add dependencies:
uv sync --all-extras- Build the documentation:
just docs- Open the documentation in your browser.
If using something like VSCode's live server:
http://127.0.0.1:5500/built_docs/html/index.html
Or open built_docs/html/index.html directly from your filesystem.
- Style guide: docs/STYLE.md
- Live rebuild while editing RST:
just docs-watch