Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Update intersphinx_mapping for Sphinx 8 compatibility (#598) #599

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

musicinmybrain
Copy link

@musicinmybrain musicinmybrain commented Feb 14, 2025

This makes the intersphinx_mapping in docs/conf.py forward-compatible with Spinx 8 by changing it from

intersphinx_mapping = {"https://docs.python.org/3/": None}

to

intersphinx_mapping = {"python": ("https://docs.python.org/3/", None)}

Checklist:

  • Add tests that demonstrate the correct behavior of the change. Tests should fail without the change. N/A; test by building and inspecting the documentation
  • Add or update relevant docs, in the docs folder and in code. N/A; nothing to document
  • Add an entry in CHANGES.rst summarizing the change and linking to the issue.
  • Add .. versionchanged:: entries in any relevant code docs. N/A; no code changes
  • Run pre-commit hooks and fix any issues.
  • Run pytest and tox, no tests failed.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

The intersphinx_mapping in docs/conf.py is incompatible with Sphinx 8
1 participant