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:

  • the development branch (master) is published as latest.

  • published releases use Git tags in the form vX.Y.Z.

  • release documentation is displayed as vX.Y.

  • release maintenance branches should be named release/vX.Y and use docs/antora.yml: version: vX.Y.

  • historical aggregation starts at v0.8 (older tags are excluded).

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

  • kub-version bump --tag writes docs/antora.yml as vX.Y for release tags.

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