docs: bump furo to 2023.03.27 #5301
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
- Bump docs build-dependencies - sphinx >=5.0.0, <7 - myst-parser >=1.0.0, <2 - sphinx-design >=0.4.1, <1 - Bump furo theme to latest version - Fix theme build errors
8f3ebc5 to
6be35ea
Compare
Member
Author
mypy's min Python version is set to 3.7: Unfortunately, changing the python version for specific modules can't be done in the mypy config, so the mypy command in the lint CI config needs to be changed. This isn't ideal, because it'll also need to get set when linting locally. This workaround can be removed once py37 sees its EOL in two months: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This updates the furo docs theme to the latest version.
The main intention however is bumping Sphinx to 6.x, which drops the unnecessary jQuery+underscore.js bloat:
https://www.sphinx-doc.org/en/master/changes.html#release-6-0-0-released-dec-29-2022
Sphinx's minimum version requirement however is 5.x (defined by furo and the other build dependencies). I decided against bumping the min version to 6.x, because Sphinx is also used for building the man page. Some Linux distros are still on Sphinx 5 and I don't want to unnecessarily introduce incompatibilities for no reason.
Sphinx 6 also drops support for py37, but we've already dropped support for building docs on py37 a while ago in 46496db
In order for being able to bump Sphinx to 5.x/6.x, myst-parser and sphinx-design needed an upgrade. Those have finally been published a couple of weeks and days ago respectively:
Bumping furo also required some fixing due to changes of the theme's
logovariable.I couldn't spot any issues after the upgrade, but please check and compare the netlify preview build first.
https://deploy-preview-5301--streamlink.netlify.app/