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 <0.6.0,>=0.5.2 to >=0.5.2,<1.1.0 #331

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Sep 14, 2021

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

Changelog

Sourced from sphinx-rtd-theme's changelog.

1.0.0

Incompatible Changes

  • The minimum supported python version is now 2.7 or 3.4 and greater (#1093)
  • The minimum supported Sphinx version is now 1.6 (#1091)

Deprecated

  • Support for Sphinx's HTML4 writer is deprecated and will be removed in version 2.0 (#1091)

Features

  • Add support for Sphinx 4.x (#1123)
  • Add support for Docutils 0.17 (#1185 and #1199)
  • Fixed logo scaling on IE11 (#1183)
  • Added support for logos as URLs (#1171)
  • Align top and side navigation background colors on mobile (#1132)
  • Added support for deep toc levels (#1089)
  • Updated translations for Chinese, Dutch, Estonian, French, German, Italian, Lithuanian, Persian, Polish, Portuguese, Russian, Spanish, Swedish, and Turkish locales

A number of accessibility features were added in this release:

  • Allow keyboard to toggle menu expansion (#1167)
  • Allow keyboard to activate permalink (#1162)
  • Show keyboard focus on buttons (#1161)
  • Maintain aria-expanded along with .current in menu (#1151)
  • Respect tab order for prev/next buttons (#1051)

Fixes

  • Updated Google analytics integration (#1129)
  • Add classifier separation on Sphinx 2+ HTML4 writer (#1192)
  • Added missing space char in footer (#1188)
  • Fix navigation right padding on level2+ elements (#1068)
  • Fix navigation expansion button sizes (#1067)
  • Wrap inline literals (#1050)
  • Fix aria labels (#1056)
  • Don't toggle navigation terminal nodes (#1049)
  • Fix <pre> overflow (#1220)
  • Fix literal/ref style inside <dl> (#1088)

Other Changes

... (truncated)

Commits
  • c9b1bde Replace sphinx reST with native reST
  • 15e4a90 Update translations for 1.0 release
  • 2254b1f Update docs and versions for 1.0.0 release
  • acada32 Merge pull request #1220 from readthedocs/nienn/fix-sphinx-4-pre-overflow
  • e319184 Merge branch 'master' into nienn/fix-sphinx-4-pre-overflow
  • 20f205f Merge pull request #1217 from readthedocs/agj/release-labels
  • 2774670 Add CSS max-width to dl.property
  • b557851 Make section labels verbose to avoid numeric labels
  • 73d1707 Merge pull request #1088 from readthedocs/Blendify/fix-717
  • 3a03112 Fix build
  • Additional commits viewable in compare view

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 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)

@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Sep 14, 2021
@dependabot dependabot bot requested a review from jklaise September 14, 2021 07:06
@dependabot dependabot bot force-pushed the dependabot/pip/sphinx-rtd-theme-gte-0.5.2-and-lt-1.1.0 branch from 4240e79 to 01cad8c Compare September 27, 2021 08:39
Updates the requirements on [sphinx-rtd-theme](https://github.com/readthedocs/sphinx_rtd_theme) to permit the latest version.
- [Release notes](https://github.com/readthedocs/sphinx_rtd_theme/releases)
- [Changelog](https://github.com/readthedocs/sphinx_rtd_theme/blob/master/docs/changelog.rst)
- [Commits](readthedocs/sphinx_rtd_theme@0.5.2...1.0.0)

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

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot force-pushed the dependabot/pip/sphinx-rtd-theme-gte-0.5.2-and-lt-1.1.0 branch from 01cad8c to 22674d7 Compare September 28, 2021 12:29
@jklaise
Copy link
Member

jklaise commented Sep 28, 2021

There is something wrong with the formatting using the new version of the theme (sidebar sections misformatted, landing page TOC without headings etc.):
image

@ascillitoe
Copy link
Contributor

I experienced the same when trying to use sphinx-rtd-theme>=0.6.0 with sphinx<3.0. Everything looks OK with the sphinx and sphinx-rtd-theme versions used in #338.

From memory I think html_context also had to be changed to html_css_files in doc/source/conf.py to work with sphinx-rtd-theme==1.0, but we can look into this further when we upgrade to sphinx==4.3.0.

@dependabot @github
Copy link
Contributor Author

dependabot bot commented on behalf of github Nov 3, 2021

Looks like sphinx-rtd-theme is up-to-date now, so this is no longer needed.

@dependabot dependabot bot closed this Nov 3, 2021
@dependabot dependabot bot deleted the dependabot/pip/sphinx-rtd-theme-gte-0.5.2-and-lt-1.1.0 branch November 3, 2021 15:59
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants