docs: bump furo docs req to 2021.09.08 #4000
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
back-to
reviewed
Sep 9, 2021
docs-requirements.txt
Outdated
| @@ -1,3 +1,3 @@ | |||
| sphinx>=3.0 | |||
| furo==2020.12.28.beta23 | |||
| furo==2021.08.31 | |||
There was a problem hiding this comment.
could be updated
There was a problem hiding this comment.
This got released two hours after I made this PR. The only relevant change here is markup related (theme button at the top).
- upgrade furo to 2021.09.08 - fix/restore custom theme overrides
bastimeyer
force-pushed
the
docs/furo/2021.08.31
branch
from
37369d2 to
975e1a2
Compare
bastimeyer
changed the title
Billy2011
added a commit
to Billy2011/streamlink-27
that referenced
this pull request
Sep 10, 2021
- upgrade furo to 2021.09.08 - fix/restore custom theme overrides
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The furo theme had its first stable release last week.
https://github.com/pradyunsg/furo/releases
Most of the changes are only bugfixes, but there's also a custom theme variant selection now which makes it worth upgrading. The only noticeable difference should be a short scroll animation for link anchors, the rest should look and behave the same except for very minor spacing changes.
This version of furo also requires sphinx 4 now, but that shouldn't be a problem anymore after 5e65d2d fixed a build option which caused problems between sphinx 3 and 4.
Please carefully compare the docs preview with the live docs before merging. There's a chance that I missed something that needs fixing because I didn't check every change in the changelog. Only tested in latest Chromium and Firefox.