Update sphinx
and furo
while removing "Edit on GitHub" hack in the process
#4341
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
When installing
sphinx
viapip install sphinx
, it depends on a number of extensions (includingsphinxcontrib-applehelp
):The newest version of
sphinxcontrib-applehelp
requiressphinx>=5.0
, yet we're currently pinningsphinx
to a4.x
version, which causes the RTD build to fail.Additionally, we're pinning a 2021 version of
furo
(presumably to avoid upstream versions unexpectedly changing the appearance of our docs), which also pins an old version ofsphinx
. So, we need to updatefuro
as well if we want to updatesphinx
.In turn, updating
sphinx
andfuro
require some additional changes:language = None
now triggers a warning, so change to'en'
extlinks
now requires explicitly using%s
in the caption instead of''
Linked issues
Fixes #4340.