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/conf.py: Use modern intersphinx_mapping format #2206

Merged
merged 1 commit into from
Aug 12, 2024

Conversation

EwoutH
Copy link
Member

@EwoutH EwoutH commented Aug 12, 2024

With Sphinx 8.0 they removed the old intersphinx_mapping format we were still using, which was introduced in Sphinx 0.5. This means an 10 year old line of code got our docs failing.

This commit updates the docs/conf.py file to use the new intersphinx_mapping format, as described here.

Resolves #2205.

With Sphinx 8.0 they removed the old `intersphinx_mapping` format we were still using, which was introduced in Sphinx 0.5. This means an 10 year old line of code got our docs failing.

This commit updates the `docs/conf.py` file to use the new `intersphinx_mapping` format, as described here: https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_mapping
Copy link

Performance benchmarks:

Model Size Init time [95% CI] Run time [95% CI]
Schelling small 🔵 -0.1% [-0.5%, +0.3%] 🔵 -0.3% [-0.6%, -0.1%]
Schelling large 🔵 +0.0% [-0.6%, +0.5%] 🔵 -1.2% [-3.4%, +1.1%]
WolfSheep small 🔵 +0.6% [-0.6%, +1.9%] 🔵 +0.8% [+0.4%, +1.2%]
WolfSheep large 🔵 -0.8% [-1.3%, -0.2%] 🟢 -4.5% [-5.8%, -3.2%]
BoidFlockers small 🔵 +1.1% [+0.5%, +1.7%] 🔵 -1.8% [-2.6%, -1.1%]
BoidFlockers large 🔵 +1.8% [+1.3%, +2.3%] 🔵 +0.4% [-0.2%, +1.0%]

@EwoutH EwoutH added docs Release notes label ci Release notes label labels Aug 12, 2024
@rht rht merged commit 6a31300 into main Aug 12, 2024
12 checks passed
@rht rht deleted the fix_docs_intersphinx_mapping branch August 12, 2024 10:31
@EwoutH EwoutH added the backport label Sep 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport ci Release notes label docs Release notes label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Readthedocs is failing on configuration error
2 participants