Skip to content

Bump sphinx-tabs from 1.3.0 to 3.1.0 #4995

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

Merged
merged 1 commit into from
Jul 6, 2021

Conversation

dependabot[bot]
Copy link
Contributor

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

Bumps sphinx-tabs from 1.3.0 to 3.1.0.

Release notes

Sourced from sphinx-tabs's releases.

Version 3.1.0

See CHANGELOG.md

Version 3.0.0

See CHANGELOG.

Version 2.1.0

See CHANGELOG.md.

Version 2.0.1

See CHANGELOG.md.

Version 2.0.0

See CHANGELOG.md.

Changelog

Sourced from sphinx-tabs's changelog.

3.1.0 - 2021-06-11

Added

  • 👌 Added mew sphinx config sphinx_tabs_disable_css_loading option to disable css from loading

3.0.0 - 2021-05-10

Fixed

  • 🐛 Update for compatibility with Sphinx 4

2.1.0 - 2021-03-10

Fixed

  • 🐛 Tabs with nested content becoming hidden on click

Improved

  • 👌 Added new sphinx config option sphinx_tabs_disable_tab_closing to allow new tab closing functionality to be disabled globally (better backwards compatibility with sphinx-tabs<2)

2.0.1 - 2021-02-07

Fixed

  • Nested parsing of tab labels, to support use of reST roles within label text
  • Parsing tabs with unsupported builders, including for pdf

Added

  • Test for successful pdf building using rinohtype

2.0.0 - 2021-01-24

♻️ Refactor to reduce JS/CSS payload size and improve accesibility:

  • Removed semantic-ui assets
  • Removed unused 'sphinx_tabs_nowarn' sphinx option
  • JS/CSS assets are now copied across by sphinx when builing, rather than being copied by the extension
  • Changed tab HTML to use tab roles
  • Changed tab label colour, to increase contrast with background
  • Added ARIA labels for tabs and panels
  • Added tabindex atributes to allow users to focus and switch tabs using a keyboard
  • Added a margin below images inside tab content

✨ New features:

  • Selecting an open tab now closes the tabs panel

... (truncated)

Commits
  • d921af3 🚀 RELEASE: v3.1.0 (#125)
  • f4d1016 🧪 TESTS: Skip failing rinohtype tests (#124)
  • 5564197 🧪 TESTS: Add tests for disable_css_loading option
  • 54776a3 👌 IMPROVE: Add sphinx option to disable css from loading
  • 69f31ff 🧪 TESTS: Fix Jest version for JS testing (#119)
  • 41cdcd3 📚 DOCS: Add PDF format to the Read The Docs config (#116)
  • 45308dd 🧪 TESTS: Add tests for JS tab functions (#109)
  • 9caafb2 🎉 RELEASE: 3.0.0
  • 0812b66 Format with Black
  • e7544a6 Sphinx 4 Support (#110)
  • Additional commits viewable in compare view

Dependabot compatibility score

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)

Bumps [sphinx-tabs](https://github.com/executablebooks/sphinx-tabs) from 1.3.0 to 3.1.0.
- [Release notes](https://github.com/executablebooks/sphinx-tabs/releases)
- [Changelog](https://github.com/executablebooks/sphinx-tabs/blob/master/CHANGELOG.md)
- [Commits](executablebooks/sphinx-tabs@v1.3.0...v3.1.0)

---
updated-dependencies:
- dependency-name: sphinx-tabs
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file python labels Jun 14, 2021
@mhilbrunner
Copy link
Member

See discussion in #4909 and #4787.

May not be an issue anymore, although the upstream issue still isn't fixed as we switched from Sphinx search to Algolia: #4884

@mhilbrunner
Copy link
Member

Tested locally, confirmed to work fine.

@mhilbrunner
Copy link
Member

Changelog from 1.3.0 to now:

Added mew sphinx config sphinx_tabs_disable_css_loading option to disable css from loading
Update for compatibility with Sphinx 4 
Tabs with nested content becoming hidden on click
Added new sphinx config option sphinx_tabs_disable_tab_closing to allow new tab closing functionality to be disabled globally (better backwards compatibility with sphinx-tabs<2)
Nested parsing of tab labels, to support use of reST roles within label text
Parsing tabs with unsupported builders, including for pdf
Test for successful pdf building using rinohtype
Refactor to reduce JS/CSS payload size and improve accesibility:
Removed semantic-ui assets
Removed unused 'sphinx_tabs_nowarn' sphinx option
JS/CSS assets are now copied across by sphinx when builing, rather than being copied by the extension
Changed tab HTML to use tab roles
Changed tab label colour, to increase contrast with background
Added ARIA labels for tabs and panels
Added tabindex atributes to allow users to focus and switch tabs using a keyboard
Added a margin below images inside tab content
Selecting an open tab now closes the tabs panel
The last selected group tab persists between pages (if the browser supports session storage)

Looks fine to me, so merge it is.

@mhilbrunner mhilbrunner merged commit b4b81f5 into master Jul 6, 2021
@dependabot dependabot bot deleted the dependabot/pip/sphinx-tabs-3.1.0 branch July 6, 2021 05:57
@mhilbrunner
Copy link
Member

Note to self: if this is cherrypicked, #5070 needs to be added too

@akien-mga
Copy link
Member

akien-mga commented Jul 22, 2021

Cherry-picked for 3.3 and 3.2.

@akien-mga
Copy link
Member

Cherry-picked for 3.3 and 3.2.

Or not, since it seems the reason it was not bumped is that it conflicts with the search extension? Undid my local cherry-pick for now.

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 enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants