-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
Docs: Fixes warnings and other noisy build messages #9453
Docs: Fixes warnings and other noisy build messages #9453
Conversation
…umentations and references
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a useful PR, but I do think we probably want to point at versions here, instead of stable
to avoid more breakage in the future.
After seeing that we were linking to several outdated docs, I would think that it's better to risk the little breakage that this can cause once in a while. For instance, we are now linking to the latest Django release (4.0) and not Django 2.2. Updating these mappings didn't require many changes, and we won't be notified in any other way when we are linking to old versions. I think we should avoid the former scenario and find a good way for our docs to break when they contain a broken reference to another documentation's latest stable release. I'd argue that it's the best practice, albeit not entirely reproducible? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's a reasonable practice, but will lead to broken docs builds more frequently the more we link out. That leads to our public docs being broken until we fix the link and redeploy, which for stable
is only once a week. Hopefully the downstream users will redirect those links though, but intersphinx doesn't have a way to handle redirects, so we won't benefit from it in our PR builds.
I'm fine with this for now, but if we see a lot of breakage, we should roll it back.
Merging with the approval, I believe that we'll automatically see more to the issue discussed since references to (labels) the "latest" or "stable" branches of intersphinx-mapped documentation will break... we just don't know how often, but we will, and then we can potentially switch back to referencing a fixed version. We'll also be able to discuss the reproducible aspect more -- note that we were never fully reproducible wrt Intersphinx, as many of those mappings were already "latest". |
Using default style (tooltip) for unknown typ (term). Define it in hoverxref_role_types.
📚 Documentation preview 📚: https://docs--9453.org.readthedocs.build/en/9453/