Skip to content

Docs point to master's (1.0.0a0) release intead of a stable release (0.12.3) #966

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

Open
th3coop opened this issue Mar 13, 2025 · 5 comments

Comments

@th3coop
Copy link

th3coop commented Mar 13, 2025

A coworker and I just had a bit of confusion with the aiocache code. We were referencing the latest docs, naively assuming that it was for 0.12.3, but nothing was matching up with the actual module code. We finally realized that the "latest" docs actually point to an alpha release, 1.0.0.a0, which appears to significant compabilities issues with earlier releases.
https://aiocache.aio-libs.org/en/latest/:
Image

That was really confusing. We're also not able to select 0.12.3 as a version so we're just going with 0.12.2 for docs. Maybe "stable" is 0.12.3 but I can't tell as the version is missing from the page when I select "stable":

Image

Not sure if this all was intentional but it sent us for a wild goose chase. If it was intentional, I'd re-think it. The default docs that load shouldn't be unreleased code.

@th3coop th3coop changed the title Docs point to master release intead of table release Docs point to master's (1.0.0a0)release intead of a stable release (0.12.3) Mar 13, 2025
@th3coop th3coop changed the title Docs point to master's (1.0.0a0)release intead of a stable release (0.12.3) Docs point to master's (1.0.0a0) release intead of a stable release (0.12.3) Mar 13, 2025
@Dreamsorcerer
Copy link
Member

Can probably look at adding a version to the docs somewhere, but latest always means master, that's just how RTD works.

@Dreamsorcerer
Copy link
Member

We can also change the default, as it appears to default to latest, which is not what we want.

@Dreamsorcerer
Copy link
Member

@asvetlov Have you got access to this one on RTD?

@Dreamsorcerer
Copy link
Member

Or @argaen?

@th3coop
Copy link
Author

th3coop commented Mar 17, 2025

We can also change the default, as it appears to default to latest, which is not what we want.

yeah, I probably could have made that point more clear. This is all I'm suggesting to do here really.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants