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

docs: Fix deprecated intersphinx_mapping format #772

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Mr0grog
Copy link
Contributor

@Mr0grog Mr0grog commented Sep 29, 2023

While working on #771, I noticed that Sphinx is logging a warning on builds because the format being used for intersphinx_mapping is deprecated and will be removed in the next major release of Sphinx:

WARNING: The pre-Sphinx 1.0 'intersphinx_mapping' format is deprecated and will be removed in Sphinx 8. Update to the current format as described in the documentation. Hint: "intersphinx_mapping = {'<name>': ('https://docs.python.org/', None)}".https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_mapping

This updates the format for intersphinx_mapping to use the newer, actively maintained format. (I’m not this matters too much, though, since there are no type annotations and none of the docstrings list types for intersphinx to make links out of. 🤷)

This updates the format for `intersphinx_mapping` to use the actively maintained format. The previous format has been deprecated for a while and is slated to be removed in the next major release of Sphinx.
@Mr0grog
Copy link
Contributor Author

Mr0grog commented Oct 4, 2023

Now that someone’s allowed tests to run on this PR, there seem to be a lot of failures. FWIW, this works well for me locally and I don’t think the changes here would have caused any test failures. Not sure if there’s anything I should be doing, or if this is just a CI configuration issue for PRs from forks, or something else.

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.

1 participant