Antora environment

Antora is our static website generator. We use it to generate the documentation of the project It is part of the documentation of docs.feelpp.org[Feel++ docs] website.

Versioning policy:

  • local/PR documentation builds publish the checked-out branch as latest (site.yml uses HEAD).

  • release documentation is sourced from maintenance branches vX.Y (or release/vX.Y for compatibility) and displayed as vX.Y.

  • maintenance branches must use docs/antora.yml: version: vX.Y.

  • kub-version bump keeps docs/antora.yml on latest for development bumps.

  • kub-version bump --tag writes docs/antora.yml as vX.Y and creates/updates maintenance branch vX.Y only for stable X.Y.0 releases.

  • software releases still use Git tags vX.Y.Z; on tag pushes, CI injects the pushed tag into a temporary Antora playbook to publish that exact release snapshot.

  • historical aggregation starts at release line v0.8 (older lines are excluded).

To generate the documentation
 $ npm install (1)
 $ npm run antora (2)
 $ npm run start (3)
1 Install the dependencies
2 Generate the documentation
3 Serve the documentation, the url is provided in the console