Skip to content

[docs] Sphinx v8 compatibility: configure a non-empty inventory name for Python Intersphinx mapping. #485

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

Merged
merged 1 commit into from
Aug 23, 2024
Merged

[docs] Sphinx v8 compatibility: configure a non-empty inventory name for Python Intersphinx mapping. #485

merged 1 commit into from
Aug 23, 2024

Conversation

jayaddison
Copy link
Contributor

From Sphinx version 8.0 onwards, some legacy behaviours of the intersphinx_mapping configuration setting will be dropped, and validation of Intersphinx mapping names is being tightened to require non-empty mapping names.

Based on a code search on GitHub I discovered your project as one that is recently-maintained and has an intersphinx_mapping configuration containing an empty-string name entry. Because only a small number of source repositories are affected, I'm opening pull requests to offer corresponding configuration updates.

Note: I'm unfamiliar with the details of the django-elasticsearch-dsl documentation, so the extent of my testing has been:

  • Install a minimal set of dependencies for the project.
  • Build the project as HTML using Sphinx v7.4.7 (the latest and perhaps last pre-v8.x release).
  • Confirmed that the documentation build succeeded.

I did notice two warnings during the build:

  • A fallback default language value of en was used by the build (it may make sense to configure this statically).
  • A failure to retrieve an inventory from https://elasticsearch-py.readthedocs.io/en/master/objects.inv occurred - this isn't directly related to the empty-string change, but does also relate to the intersphinx_mapping config. The preferred alternative path seems to be of the form: https://elasticsearch-py.readthedocs.io/en/latest/objects.inv

@jayaddison
Copy link
Contributor Author

cc @safwanrahman - this isn't urgent, but should allow any future upgrade to Sphinx v8 while also maintaining backwards-compatibility.

@safwanrahman
Copy link
Collaborator

LGTM. r+
Thanks for your contribution

@safwanrahman safwanrahman merged commit e453aff into django-es:master Aug 23, 2024
@jayaddison jayaddison deleted the maintenance/sphinx-v8-intersphinx-mapping branch August 23, 2024 12:01
@jayaddison
Copy link
Contributor Author

You're welcome; thank you!

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