Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

GitHub Pages Title Version Mismatch #1725

Open
WeeknightMVP opened this issue Aug 12, 2024 · 2 comments
Open

GitHub Pages Title Version Mismatch #1725

WeeknightMVP opened this issue Aug 12, 2024 · 2 comments
Labels
docs LaTeX, markdown, literate haskell, or in-REPL documentation

Comments

@WeeknightMVP
Copy link

WeeknightMVP commented Aug 12, 2024 •
edited
Loading

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 RyanGlScott added the docs LaTeX, markdown, literate haskell, or in-REPL documentation label Aug 13, 2024
@RyanGlScott
Copy link
Contributor

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

cryptol/docs/RefMan/conf.py

Line 31 in df4c9df

release = '2.11.0'

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
Copy link
Contributor

In the meantime, we have bumped the release line to show 3.2.0 (the latest Cryptol release version) in #1736.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs LaTeX, markdown, literate haskell, or in-REPL documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@RyanGlScott @WeeknightMVP