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

Update sphinx-rtd-theme requirement from <3.0,>=1.0 to >=1.0,<4.0 #236

Merged
merged 5 commits into from
Oct 31, 2024

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Oct 7, 2024

Updates the requirements on sphinx-rtd-theme to permit the latest version.

Changelog

Sourced from sphinx-rtd-theme's changelog.

3.0.0

Final version.

.. _release-3.0.0rc4:

3.0.0rc4

Fixes

  • Trigger "Read the Docs Search addon" when focusing the "Search docs" input in the navbar.

.. _release-3.0.0rc3:

3.0.0rc3

Fixes

  • Show hidden version in selector if it's the current active version

.. _release-3.0.0rc2:

3.0.0rc2

Added

  • Render version and language selectors below the documentation's title (top left). This can be controlled via the new theme options version_selector and language_selector.

.. _release-3.0.0rc1:

3.0.0rc1

Added

  • Added support for Sphinx 8.
  • Added support for Python 3.12.
  • Added support for docutils >0.18, <0.22.
  • Populate html_context with all the environment variables starting with READTHEDOCS_.

Deprecations

... (truncated)

Commits

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Updates the requirements on [sphinx-rtd-theme](https://github.com/readthedocs/sphinx_rtd_theme) to permit the latest version.
- [Changelog](https://github.com/readthedocs/sphinx_rtd_theme/blob/master/docs/changelog.rst)
- [Commits](readthedocs/sphinx_rtd_theme@1.0.0...3.0.0)

---
updated-dependencies:
- dependency-name: sphinx-rtd-theme
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file patch Change that results in a new patch version labels Oct 7, 2024
@dependabot dependabot bot requested a review from andthum October 7, 2024 08:48
@andthum
Copy link
Owner

andthum commented Oct 31, 2024

The configuration option display_version is deprecated since sphinx-rtd-theme version 3.0.0.

Note that the new recommended option version_selector requires the documentation to be hosted on Read the Docs, because it makes use of Read the Docs Addons.

Suggestion: Use the recommended option version_selector.

@andthum andthum force-pushed the dependabot/pip/sphinx-rtd-theme-gte-1.0-and-lt-4.0 branch from 14f3ad5 to 48681f6 Compare October 31, 2024 14:11
sphinx-rtd-theme version 3.0 drops support for Python `<3.8`
(https://sphinx-rtd-theme.readthedocs.io/en/latest/changelog.html#rc1).
Because MDTools supports Python `>=3.6, <3.10`, sphinx-rtd-theme should
not be updated.
Use `macos-13` instead of `macos-latest` like in `tests.yml`.
@andthum andthum force-pushed the dependabot/pip/sphinx-rtd-theme-gte-1.0-and-lt-4.0 branch from ea1da15 to 4a50247 Compare October 31, 2024 14:32
@andthum andthum merged commit c478cdf into main Oct 31, 2024
19 checks passed
@andthum
Copy link
Owner

andthum commented Oct 31, 2024

sphinx-rtd-theme version 3.0 drops support for Python <3.8 (https://sphinx-rtd-theme.readthedocs.io/en/latest/changelog.html#rc1). Because MDTools supports Python >=3.6, <3.10, sphinx-rtd-theme should not be updated.

@dependabot ignore this major version

Copy link
Contributor Author

dependabot bot commented on behalf of github Oct 31, 2024

OK, I won't notify you about version 3.x.x again, unless you re-open this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file patch Change that results in a new patch version
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant