Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: bump docs-requirements#6126

Merged
bastimeyer merged 2 commits into
streamlink:masterfrom
bastimeyer:docs/update-docs-requirements
Aug 12, 2024
Merged

docs: bump docs-requirements#6126
bastimeyer merged 2 commits into
streamlink:masterfrom
bastimeyer:docs/update-docs-requirements

Conversation

@bastimeyer

Copy link
Copy Markdown
Member

This bumps

  1. myst-parser to >=1.0.0,<5 (from >=1.0.0,<4), including sphinx to >=6.0.0,<9 (from >=6.0.0,<8)
  2. the furo theme to the latest version

I intentionally left out bumping sphinx-design to the latest version (0.6.1), because it removes support for building the docs on py38. This however also means that the current sphinx-design ==0.5.0 docs-requirement limits us to sphinx <8. That shouldn't be an issue though and will be changed as soon as py38 support will be dropped in October. Even though it's probably super irrelevant keeping py38 support for building the docs right now, I just don't want to introduce this technical breaking change in a non-major-version bump.

py312

$ pip list | grep -Ei '(sphinx(_design)?|myst-parser|furo|docutils)\s'
docutils                      0.21.2
furo                          2024.8.6
myst-parser                   4.0.0
Sphinx                        7.4.7
sphinx_design                 0.5.0

py38

$ pip list | grep -Ei '(sphinx(_design)?|myst-parser|furo|docutils)\s'
docutils                      0.20.1
furo                          2024.8.6
myst-parser                   3.0.1
Sphinx                        7.1.2
sphinx_design                 0.5.0

If there are any packagers who want to build the docs with sphinx-design ==0.5.0 and sphinx >=8.0.0, this works perfectly fine, apart from one deprecation warning which will need to be fixed at some point in the future.

Running Sphinx v8.0.2
/home/basti/repos/streamlink/docs/conf.py:225: RemovedInSphinx90Warning: Tags.tags is deprecated, use methods on Tags.
  if not tags.tags.get("man"):  # type: ignore[name-defined]

@bastimeyer bastimeyer merged commit 903cd93 into streamlink:master Aug 12, 2024
@bastimeyer bastimeyer deleted the docs/update-docs-requirements branch August 12, 2024 09:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant