-
-
Notifications
You must be signed in to change notification settings - Fork 3.1k
Clarify Read the Docs versioning and retention of older versions #20560
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
base: master
Are you sure you want to change the base?
Conversation
|
According to mypy_primer, this change doesn't affect type check results on a corpus of open source code. ✅ |
|
I don't see how this would actually fix #19922 unless some other change is made to actually accomplish this goal. |
Good point, this PR is documentation-only. It doesn’t change RTD behavior, but clarifies that versioning is based on git tags and that older docs are expected to remain available. The intent is to address the confusion raised in #19922 rather than implement a tooling change. Happy to adjust scope or issue linkage if needed |
|
I'm afraid that the text proposed in this PR is also wrong? Right now only two version aliases - "stable" and "latest" - are available on RTD. Being able to fetch a git tag and build RTD pages locally does not constitute easy versioned docs access, and your text seems to suggest that one can go to RTD and find the desired version by git tag there. |
|
@sterliakov he's basically proposing someone fix #19922, after which his proposed text will be true (although possibly not worth mentioning anyway...) |
|
Thanks @sterliakov for catching that, and @wyattscarpenter for clarifying my intent |
|
If we do eventually get more versions in RTD I don't really see the point in documenting that? I believe it'll only apply for new versions (so not useful for a while) and even then there'll be the little RTD addon that lets you choose versions. |
What this PR does
Clarifies that mypy documentation on Read the Docs is intended to be
versioned using released git tags, and that older documentation versions
are kept available.
Why
Read the Docs supports documentation versioning for community projects.
Using git tags avoids relying on long-lived maintenance branches while
still allowing users to access documentation for older mypy releases.
Scope
Documentation-only change. No impact on mypy runtime or type checking.
Fixes #19922