- Sponsor
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Add an option to not use intersphinx references as a fallback #2068
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
Comments
Strictly using prefix for intersphinx links gives a better control on external links - only links explicitely declared will point to the external documentation. Fixes sphinx-doc#2068
The initial PR adding this is #8981 |
Strictly using prefix for intersphinx links gives a better control on external links - only links explicitely declared will point to the external documentation. Fixes sphinx-doc#2068
Strictly using prefix for intersphinx links gives a better control on external links - only links explicitely declared will point to the external documentation. Fixes sphinx-doc#2068
Fixes sphinx-doc#2068 Replaces sphinx-doc#8981
I know that I'm 6 years late and apparently clusterhq is no more, but for future reference, I just wanted to say that it looks weird to me to have an |
@astrojuanlu I believe that it was so that we could keep old versions of the documentation alive in |
Fixes sphinx-doc#2068 Replaces sphinx-doc#8981
Fixes sphinx-doc#2068 Replaces sphinx-doc#8981
Fixes sphinx-doc#2068 Replaces sphinx-doc#8981
Fixes sphinx-doc#2068 Replaces sphinx-doc#8981
That intersphinx references are used as fallbacks if a reference is not available in a project recently caused us a problem.
We have a site (
latest
) which is the latest build ofmaster
.We use intersphinx as follows, so we can link to the latest documentation in some sections:
Our docs included a label (
.. foo:
) so this reference was available onlatest
.This label was removed on a branch, along with one of the two references to this label.
In this case we would expect that building the branch would fail, as there is a reference to a label which doesn't exist.
Unexpectedly, the branch built successfully, because the label was found in
latest
as a fall back when it was not found locally. The branch was merged, and then later, whenlatest
changed (becausemaster
was built again) builds stopped working because there was a reference to a non-existent label.It would be good to have an option to not fall back, maybe something like
nitpicky
.The text was updated successfully, but these errors were encountered: