Skip to content

README.md

Latest commit

 

History

History
35 lines (23 loc) · 1.16 KB

README.md

File metadata and controls

35 lines (23 loc) · 1.16 KB

CALYPR Docs

This Zensical-based codebase deploys documentation to calypr.org.

CALYPR Homepage

Local Development

python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
make serve

The local build contract is:

  • make prepare stages repo-authored docs plus imported upstream tool docs into .generated/docs
  • make build runs a clean Zensical build
  • make serve stages the docs and starts the local Zensical server

For repo maintenance details, navigation ownership, and import behavior, see DEVELOPING.md.

If you prefer the raw commands:

python scripts/prepare_docs.py
zensical serve

Publishing to calypr.org

The site is automatically built and published on every push to main using the GitHub Actions workflow in publish.yml. Netlify uses the same Zensical build pipeline.

To skip CI for a commit, add [skip ci] (or any equivalent variation) to the commit message.