sphinx-tabs

What's Changed

• FIX: unpin docutils by @agoose77 in #186

New Contributors

• @agoose77 made their first contribution in #186

Full Changelog: v3.4.4...v3.4.5

Removed

• docutils version pin

What's Changed

• Change testing to only cover latest sphinx version by @foster999 in #167

Full Changelog: v3.4.0...v3.4.1

Added

• Weekly scheduled testing, to catch breaking changes in unpinned dependencies

Changed

• docutils version pin to allow use of verison 0.18.x

Removed

• sphinx version pinning - only the latest version of sphinx will now be fully supported, but previous versions will work if sphinx dependencies (i.e. jinja2) are managed correctly. This is inline with the approach at sphinx
• tests that were specific to older versions of sphinx and pygments
• jinja2 version pinning, as this is now pinned in latest version of sphinx

What's Changed

• Change git to https in pre-commit-hooks by @eyllanesc in #158
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in #156
• DOCS: Fix typos by @kianmeng in #157
• 👌 IMPROVE: Add support and testing for sphinx 5 by @foster999 in #164
• 🐛 FIX: Fix to stop stripping of first line in MyST content by @reiyw in #165

New Contributors

• @kianmeng and @reiyw made their first contributions

Full Changelog: v3.3.1...v3.4.0

Added

• Testing for sphinx 5
• Tesing for python 3.10

Fixed

• Fixed parsing of MyST content, where first line was being stripped
• Typos in documentation
• Failing regression tests

Changed

• Testing to use an up-to-date pytest version

Removed

• Testing for python 3.6 and sphinx versions 2 and 4 (see #164). Note that the package will likely continue to work fine with these, but this won't be assured by tests

See changelog.md

What's Changed

• [fix] don't append CSS files to the end of html_static_path list by @return42 in https://github.com/executablebooks/sphinx-tabs/pull/153
• [fix] prefers-color-scheme: use dark theme if body[data-theme="auto"] by @return42 in https://github.com/executablebooks/sphinx-tabs/pull/154

New Contributors

• @return42 made their first contribution in https://github.com/executablebooks/sphinx-tabs/pull/153

Full Changelog: https://github.com/executablebooks/sphinx-tabs/compare/v3.3.0...v3.3.1

Fixed

• Inserting CSS at the start of the static path list, so that it can be overwritten
• Assume light theme is the default, even when browser setting prefers dark. Necessary when most sphinx themes don't set data-theme.

Added

• Testing for Python 3.9 and a few pygments versions
• Dark theme selectors

Changed

• Bumped docutils dependency to 0.17
• Remaining string formatting to use f-strings

Fixed

• 🐛 Added default value for exports in JavaScript. Removes error that exports is not defined on page

Added

• 👌 Use of sphinx HTML assets policy to decide whether include assets

Added

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

Fixed

• 🐛 Update for compatibility with Sphinx 4

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)

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

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

• 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 attributes 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
• The last selected group tab persists between pages (if the browser supports session storage)

♻️ Major refactor of tabs, group-tabs and code-tabs (thanks to @foster999):

• Removes hard-coded reStructuredText for group and code tabs, so that this works with other parsers (inc MyST Markdown)
• group-tab directive now subclasses TabDirective to remove duplicated run code
• likewise, code-tab now subclasses group-tab
• TabDirective and TabsDirective now subclass SphinxDirective for easier access to directive env

🧪 testing infrastructure has now fully moved from unittest to pytest

✨ New features:

• Can now pass code-tabs with a second argument (allowing whitespace) to provide an alternative tab label
• code-tabs can now use custom lexers, which are added to the sphinx app in conf.py

sphinx-tabs has now moved to the EBP organisation 🎉

Deprecated 🗑

• Python < 3.5 and Sphinx < 2 support dropped

Improved 👌

• Lots of code and CI restructuring (see EBP Migration (#76))

Fixed 🐛

• Replace add_javascript by add_js for sphinx>=3 (removes warning!), thanks to @Daltz333

• Marked the extension as parallel safe (#46)

• Fix group tabs behaviour (#31)

• Fix broken javascript file inclusion

• Add support for dirhtml builder

• Allow multiple group tabs with the same name (the ordering of the tabs is used to determine the group ids)
• Use b64 encoding of group id for group tabs to avoid illegal character in CSS class

• Initial version