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

PEP 621: Remove invalid reference #3564

Merged
merged 1 commit into from
Dec 5, 2023
Merged

PEP 621: Remove invalid reference #3564

merged 1 commit into from
Dec 5, 2023

Conversation

vstinner
Copy link
Member

@vstinner vstinner commented Dec 5, 2023

The reference is not rendered, not used, and it doesn't exist.


📚 Documentation preview 📚: https://pep-previews--3564.org.readthedocs.build/

The reference is not rendered, not used, and it doesn't exist.
@vstinner
Copy link
Member Author

vstinner commented Dec 5, 2023

PEP 639 and PEP 739 point to https://packaging.python.org/en/latest/specifications/declaring-project-metadata/ ... which is now a HTTP 404 "Not Found" error.

@vstinner
Copy link
Member Author

vstinner commented Dec 5, 2023

This change fix a build error on my PR #3560:

peps/pep-0621.rst:23: WARNING: undefined label: 'packaging:declaring-project-metadata'
...
make: *** [Makefile:22: html] Error 1

make dirhtml JOBS=$(nproc) runs PATH=.venv/bin:$PATH sphinx-build -b dirhtml -j 4 -W --keep-going -w sphinx-warnings.txt peps build where sphin-build -W option stands for: treat warnings as errors.

cc @brettcannon @hugovk

@vstinner vstinner merged commit 15dbd26 into python:main Dec 5, 2023
7 checks passed
@vstinner vstinner deleted the pep621 branch December 5, 2023 11:09
@hugovk
Copy link
Member

hugovk commented Dec 5, 2023

We shouldn't delete canonical links to specs.

Please see #3563 which fixes it instead :)

@vstinner
Copy link
Member Author

vstinner commented Dec 5, 2023

I'm not sure why Sphinx decided to emit a new warning. On the previous commit, the "Render PEPs" job didn't emit a warning: https://github.com/python/peps/actions/runs/7075200705/job/19257061142 sphinx-build was already run with -W option. And it was the same Sphinx version: Sphinx-7.2.6.

Before (success), versions:

Successfully installed Jinja2-3.1.2 MarkupSafe-2.1.3 Pygments-2.17.2 Sphinx-7.2.6 alabaster-0.7.13 babel-2.13.1 certifi-2023.11.17 charset-normalizer-3.3.2 colorama-0.4.6 coverage-7.3.2 docutils-0.20.1 idna-3.6 imagesize-1.4.1 iniconfig-2.0.0 livereload-2.6.3 packaging-23.2 pluggy-1.3.0 pytest-7.4.3 pytest-cov-4.1.0 requests-2.31.0 setuptools-69.0.2 six-1.16.0 snowballstemmer-2.2.0 sphinx-autobuild-2021.3.14 sphinxcontrib-applehelp-1.0.7 sphinxcontrib-devhelp-1.0.5 sphinxcontrib-htmlhelp-2.0.4 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.6 sphinxcontrib-serializinghtml-1.1.9 tornado-6.4 urllib3-2.1.0

On my PR, when the job failed, versions: same versions!

Successfully installed Jinja2-3.1.2 MarkupSafe-2.1.3 Pygments-2.17.2 Sphinx-7.2.6 alabaster-0.7.13 babel-2.13.1 certifi-2023.11.17 charset-normalizer-3.3.2 colorama-0.4.6 coverage-7.3.2 docutils-0.20.1 idna-3.6 imagesize-1.4.1 iniconfig-2.0.0 livereload-2.6.3 packaging-23.2 pluggy-1.3.0 pytest-7.4.3 pytest-cov-4.1.0 requests-2.31.0 setuptools-69.0.2 six-1.16.0 snowballstemmer-2.2.0 sphinx-autobuild-2021.3.14 sphinxcontrib-applehelp-1.0.7 sphinxcontrib-devhelp-1.0.5 sphinxcontrib-htmlhelp-2.0.4 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.6 sphinxcontrib-serializinghtml-1.1.9 tornado-6.4 urllib3-2.1.0

@hugovk
Copy link
Member

hugovk commented Dec 5, 2023

Because we use intersphinx, which loads references from other Sphinx websites, in this case https://packaging.python.org.

Last night they merged a re-org which deleted a reference we were using.

@hugovk
Copy link
Member

hugovk commented Dec 5, 2023

More on intersphinx: https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html

We also use it to load references from CPython docs and the devguide, see these lines in the logs:

loading intersphinx inventory from https://docs.python.org/3/objects.inv...
loading intersphinx inventory from https://packaging.python.org/en/latest/objects.inv...
loading intersphinx inventory from https://devguide.python.org/objects.inv...
loading intersphinx inventory from https://docs.python.org/3.11/objects.inv...
loading intersphinx inventory from https://docs.python.org/3.12/objects.inv...

@vstinner
Copy link
Member Author

vstinner commented Dec 5, 2023

Because we use intersphinx, which loads references from other Sphinx websites, in this case https://packaging.python.org/.

Oh, I didn't know this Sphinx feature.

@vstinner
Copy link
Member Author

vstinner commented Dec 5, 2023

Follow-up: @hugovk wrote #3563

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.

2 participants