Files
alt-ergo/docs/sphinx_docs/API/index.md
Basile Clément 35be1380ee feat(doc): Versioned documentation pages (#1176)
This patch overhauls documentation generation to support separate
documentation pages for each Alt-ergo version on the GitHub pages
website.

We generate one version for the `next` and `main` branch, and one
version for each tag of the form `v*.*.*`. The version selector from
Sphinx is used to allow users to change the version (it appears in the
lower-right corner of the page).

We also keep a `latest` version that points to the latest tag that was
built (using a symbolic link). The default page redirects to the
`latest` version.

As part of this overhaul of the documentation workflow, the OCaml
documentation built by `odoc` is now also versioned and added to the
`API` sub-directory of the Sphinx documentation (with a placeholder to
prevent Sphinx from complaining).

Fixes #693
2024-07-24 16:47:28 +02:00

145 B

API documentation

This is a placeholder to resolve references. It is replaced with the OCaml documentation when publishing the documentation.