Skip to content

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

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
Jul 22, 2024
Merged

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

merged 1 commit into from
Jul 22, 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 libtmux documentation, so the extent of my testing has been:

  • Install a minimal set of dependencies for the project.
  • Disable the linkify_issues Sphinx extension since I couldn't initially find the origin for it.
  • 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.

@CLAassistant
Copy link

CLAassistant commented Jul 22, 2024

CLA assistant check
All committers have signed the CLA.

@tony
Copy link
Member

tony commented Jul 22, 2024

@jayaddison You signed the CLA too. Perfect!

Smart, searching GitHub Search like that!

Copy link

codecov bot commented Jul 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.54%. Comparing base (aa2965e) to head (3cfd878).

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #542      +/-   ##
==========================================
+ Coverage   88.51%   88.54%   +0.02%     
==========================================
  Files          36       36              
  Lines        3927     3927              
  Branches      570      570              
==========================================
+ Hits         3476     3477       +1     
+ Misses        310      308       -2     
- Partials      141      142       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@tony tony merged commit 36ce6f9 into tmux-python:master Jul 22, 2024
21 checks passed
@jayaddison jayaddison deleted the maintenance/sphinx-v8-intersphinx-mapping branch July 22, 2024 22:38
@jayaddison
Copy link
Contributor Author

Thanks @tony!

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