Skip to content
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

Keep old reference to fix PEP 621 build #1434

Merged
merged 2 commits into from
Dec 12, 2023
Merged

Keep old reference to fix PEP 621 build #1434

merged 2 commits into from
Dec 12, 2023

Conversation

hugovk
Copy link
Contributor

@hugovk hugovk commented Dec 4, 2023

The removal of the .. _declaring-project-metadata:reference in #1396 has broken the PEPs build because PEP 621 used to link here via Intersphinx:

peps/pep-0621.rst:23: WARNING: undefined label: 'packaging:declaring-project-metadata'

https://github.com/python/peps/actions/runs/7092751804/job/19304712978

https://github.com/python/peps/blob/ff0702ebfce6e5196a0969e609d2a45e5bd41843/peps/pep-0621.rst?plain=1#L23

I think retaining the old reference should fix it.

Instead/also, we could update PEP 621 to point to the new reference. I don't really mind, but there could be other sites also linking via intersphinx so perhaps this is the more general fix.


📚 Documentation preview 📚: https://python-packaging-user-guide--1434.org.readthedocs.build/en/1434/

@webknjaz
Copy link
Member

webknjaz commented Dec 5, 2023

@hugovk looks like maybe an empty line is needed?

@hugovk
Copy link
Contributor Author

hugovk commented Dec 5, 2023

No, they can be next to each other, see for example https://github.com/python/devguide/blob/main/documentation/start-documenting.rst?plain=1

The other warnings were also introduced by the re-org in #1396 plus another PR landing at the same time, see #1396 (comment).

Edit: And will be fixed by #1433.

@jeanas
Copy link
Contributor

jeanas commented Dec 5, 2023

I'm not against preserving labels when doing reorganizations. I want to point out, though, that if we want to treat our Intersphinx "interface" as public API, we also need to avoid removing any rst files, using orphan pages instead, since they can also be referenced with :doc:. This relates to the discussion in #1401.

@hugovk
Copy link
Contributor Author

hugovk commented Dec 12, 2023

We've fixed this for the PEPs by updating the reference:

python/peps#3563

However, we're still running into build failures when updating PRs created more than a week ago, for example:

We can fix them by updating them from main, however it would still be useful to merge this to preserve the old name, and avoid surprises for others.

Thank you!

@willingc willingc added this pull request to the merge queue Dec 12, 2023
@willingc
Copy link
Contributor

Thanks @hugovk.

Merged via the queue into pypa:main with commit af8af52 Dec 12, 2023
5 checks passed
@hugovk hugovk deleted the patch-1 branch December 12, 2023 05:16
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 this pull request may close these issues.

None yet

6 participants