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

Remove trailing slashes from intersphinx inventory URLs #4239

Closed
wants to merge 1 commit into from

Conversation

Viicos
Copy link
Contributor

@Viicos Viicos commented Jan 29, 2025

From the Sphinx output:

loading intersphinx inventory 'devguide' from https://devguide.python.org//objects.inv ...
loading intersphinx inventory 'mypy' from https://mypy.readthedocs.io/en/latest//objects.inv ...
loading intersphinx inventory 'packaging' from https://packaging.python.org/en/latest//objects.inv ...
loading intersphinx inventory 'py3.11' from https://docs.python.org/3.11//objects.inv ...
loading intersphinx inventory 'py3.12' from https://docs.python.org/3.12//objects.inv ...
loading intersphinx inventory 'py3.13' from https://docs.python.org/3.13//objects.inv ...
loading intersphinx inventory 'py3.14' from https://docs.python.org/3.14//objects.inv ...
loading intersphinx inventory 'python' from https://docs.python.org/3//objects.inv ...
loading intersphinx inventory 'trio' from https://trio.readthedocs.io/en/latest//objects.inv ...
loading intersphinx inventory 'typing' from https://typing.readthedocs.io/en/latest//objects.inv ...
intersphinx inventory has moved: https://packaging.python.org/en/latest//objects.inv -> https://packaging.python.org/en/latest/objects.inv
intersphinx inventory has moved: https://typing.readthedocs.io/en/latest//objects.inv -> https://typing.readthedocs.io/en/latest/objects.inv
intersphinx inventory has moved: https://mypy.readthedocs.io/en/latest//objects.inv -> https://mypy.readthedocs.io/en/latest/objects.inv
intersphinx inventory has moved: https://trio.readthedocs.io/en/latest//objects.inv -> https://trio.readthedocs.io/en/latest/objects.inv

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

@Viicos Viicos requested a review from AA-Turner as a code owner January 29, 2025 13:54
@AA-Turner
Copy link
Member

I think this is a bug in Sphinx 8.1 that is fixed in 8.2. I will check (if so, we don't need to merge this)

@Viicos
Copy link
Contributor Author

Viicos commented Jan 29, 2025

You mean Sphinx will check if there's a trailing slash, and conditionally append /objects.inv or objects.inv?

@hugovk
Copy link
Member

hugovk commented Jan 29, 2025

Yes, it's a Sphinx 8.0 bug fixed in Sphinx 8.1 -- I know because at one point I was going to submit a PR to fix it in Sphinx but saw it had already been fixed :)

Running Sphinx v8.0.2
loading translations [en]... done
making output directory... done
loading intersphinx inventory 'python' from https://docs.python.org/3//objects.inv ...
loading intersphinx inventory 'packaging' from https://packaging.python.org/en/latest//objects.inv ...
loading intersphinx inventory 'typing' from https://typing.readthedocs.io/en/latest//objects.inv ...
loading intersphinx inventory 'trio' from https://trio.readthedocs.io/en/latest//objects.inv ...
loading intersphinx inventory 'devguide' from https://devguide.python.org//objects.inv ...
loading intersphinx inventory 'py3.11' from https://docs.python.org/3.11//objects.inv ...
loading intersphinx inventory 'py3.12' from https://docs.python.org/3.12//objects.inv ...
loading intersphinx inventory 'py3.13' from https://docs.python.org/3.13//objects.inv ...
loading intersphinx inventory 'py3.14' from https://docs.python.org/3.14//objects.inv ...
Running Sphinx v8.1.3
loading translations [en]... done
making output directory... done
loading intersphinx inventory 'python' from https://docs.python.org/3/objects.inv ...
loading intersphinx inventory 'packaging' from https://packaging.python.org/en/latest/objects.inv ...
loading intersphinx inventory 'typing' from https://typing.readthedocs.io/en/latest/objects.inv ...
loading intersphinx inventory 'trio' from https://trio.readthedocs.io/en/latest/objects.inv ...
loading intersphinx inventory 'devguide' from https://devguide.python.org/objects.inv ...
loading intersphinx inventory 'py3.11' from https://docs.python.org/3.11/objects.inv ...
loading intersphinx inventory 'py3.12' from https://docs.python.org/3.12/objects.inv ...
loading intersphinx inventory 'py3.13' from https://docs.python.org/3.13/objects.inv ...
loading intersphinx inventory 'py3.14' from https://docs.python.org/3.14/objects.inv ...

We need to resolve #4087 before moving to 8.1+.

@hugovk
Copy link
Member

hugovk commented Jan 29, 2025

sphinx-doc/sphinx#12782 / sphinx-doc/sphinx#12807 is the Sphinx 8.1.0 fix.

@Viicos
Copy link
Contributor Author

Viicos commented Jan 29, 2025

Thanks @AA-Turner @hugovk, I'll close this one :)

@Viicos Viicos closed this Jan 29, 2025
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.

3 participants