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.

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

ReadTheDocs not updated for 3.14 release #10754

Closed
adamgundry opened this issue Jan 16, 2025 · 5 comments
Closed

ReadTheDocs not updated for 3.14 release #10754

adamgundry opened this issue Jan 16, 2025 · 5 comments
Labels
documentation re: readthedocs Concerning hosting documentation on `readthedocs` type: bug

Comments

@adamgundry
Copy link
Member

Cabal 3.14 has been released, but https://cabal.readthedocs.io/en/stable/ still shows 3.12 as the "stable" release. Is that intended?

Moreover, the "latest" and "3.14" options show a version number of 3.13.0.0, and selecting "3.14" yields a message "This may be an old version of this documentation".

@ulysses4ever
Copy link
Collaborator

Was it @fgaz who last tried to fix it?

@adamgundry adamgundry added the re: readthedocs Concerning hosting documentation on `readthedocs` label Jan 31, 2025
@andreasabel
Copy link
Member

I also discovered this now, it looks like this:

Image

The 3.13.0.0 probably stems from here:

version = "3.13.0.0"

I suppose the release checklist should contain a bullet point reminding the release manager to update this version number.

@ulysses4ever
Copy link
Collaborator

Ah, good catch. I recently added this to fix the stable version. It hasn't been verified yet because there were no merges and hence no updates to RTD. But it looks like the latest one needs one more step, indeed.

I'm also not happy about how hard it is to find the version number in the RTD interface: it's very low contrast.

Image

I wonder if there's some CSS that we could tweak somewhere...

And another thing I always try to find and fail is the commit SHA the docs were built from. I wonder if it's possible to put it to a prominent place.

@ulysses4ever
Copy link
Collaborator

Actually, docs/conf.py is covered in the release notes: https://github.com/haskell/cabal/wiki/Making-a-release#c3-bumping-version-numbers

@ulysses4ever
Copy link
Collaborator

This is fixed now. It was way harder than I'd hoped for. The release checklist had all the right things, they were just ignored during the release, it seems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation re: readthedocs Concerning hosting documentation on `readthedocs` type: bug
Projects
None yet
Development

No branches or pull requests

3 participants