Skip to content

Avoid the intersphinx mapping to ourselves? #1438

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

Closed
jeanas opened this issue Dec 5, 2023 · 1 comment · Fixed by #1439
Closed

Avoid the intersphinx mapping to ourselves? #1438

jeanas opened this issue Dec 5, 2023 · 1 comment · Fixed by #1439

Comments

@jeanas
Copy link
Contributor

jeanas commented Dec 5, 2023

After the merge of #1396, builds started to fail with errors about undefined references, which was normal because some labels were removed that indeed had references pointing to them. (This was fixed in #1433.) The problem is that this was not caught before the merge, even though the GitHub merge queue was used to merge the PR. The merge queue is supposed to check the result of merging the PR branch into master (as opposed to just checking the PR branch).

I did some digging into this mystery and it seems to me that this was caused by this oddity in our conf.py:

intersphinx_mapping = {
    # ...
    "packaging.python.org": ("https://packaging.python.org/en/latest/", None),
    # ...
}

So... what happened is that while the PR was not merged, the references :ref:`declaring-build-dependencies` was resolved to to be an Intersphinx reference to the deployment https://packaging.python.org ! And then, after the PR got merged, the targets were removed by the deployment and the references logically became dangling.

You can see this on the PR preview of #1396:

https://python-packaging-user-guide--1396.org.readthedocs.build/en/1396/guides/modernize-setup-py-project/

image

Here I'm hovering on the first link, which points to inside the PR preview.

image

And here I hover on the second link, which points to https://packaging.python.org instead, with a tooltip indicating an external link.

I'm going to open a PR to remove that entry in the Intersphinx mapping.

jeanas added a commit to jeanas/packaging.python.org that referenced this issue Dec 5, 2023
Fixes pypa#1438

Also replace a few hyperlinks inside packaging.python.org with normal
references.
@hugovk
Copy link
Contributor

hugovk commented Dec 5, 2023

Oh, that's tricky one! Good work tracking it down!

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

Successfully merging a pull request may close this issue.

2 participants