4 Commits

Author SHA1 Message Date
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
Albin Coquereau
2a46cdeba9 Fix sphinx documentation building (#440) 2021-02-10 14:40:07 +01:00
Albin Coquereau
1b4e9d4d5a Updating Changes.md file (#410)
* Updating Changes.md file

* Fix 2.4.0 version in documentation
2021-01-21 14:59:18 +01:00
Louis Rustenholz
c45c511fa0 Doc-Alt-Ergo (#358)
* Sphinx documentation included

* Travis integration

* Fix install and usage documentation. Add dev (architecture,contributing) and about (license,changes, ressources) section in the doc

Co-authored-by: Louis RUSTENHOLZ <louis.rustenholz@polytechnique.edu>
Co-authored-by: Albin Coquereau <albin.coquereau@ocamlpro.com>
Co-authored-by: Albin Coquereau <6535385+OCamlPro-Coquera@users.noreply.github.com>
Co-authored-by: Mohamed Iguernlala <4703008+OriginLabs-Iguernlala@users.noreply.github.com>
2020-12-03 09:38:52 +01:00