search

GaloisInc / cryptol

Cryptol: The Language of Cryptography
https://galoisinc.github.io/cryptol/master/RefMan.html
BSD 3-Clause "New" or "Revised" License
1.14k stars 123 forks source link

GitHub Pages Title Version Mismatch #1725

Open WeeknightMVP opened 1 month ago

WeeknightMVP commented 1 month ago

The GitHub Reference Manual displays a <head> with <title>Cryptol Reference Manual — Cryptol 2.11.0 documentation</title>. This remains true for master, 3.0.0, 3.1.0, or other versions. The generated version selection drowdown dropdown shows the correct version, but this is not reflected in the page <title> (rendered from constant text in the template docs/RefMan/_build/html/RefMan.html and likewise for other pages in the manual).

RyanGlScott commented 1 month ago

I suspect that this is due to this line not being updated:

https://github.com/GaloisInc/cryptol/blob/df4c9df73c163fcffebe96a570788f812d618237/docs/RefMan/conf.py#L31

While we could just update that to 3.1.0, that wouldn't fully solve the problem, because the <title> would show the wrong version number when looking at the docs for a previous version (e.g., 3.0.0). Ideally, conf.py should dynamically query the version number and render it accordingly.

RyanGlScott commented 2 weeks ago

In the meantime, we have bumped the release line to show 3.2.0 (the latest Cryptol release version) in https://github.com/GaloisInc/cryptol/pull/1736.