v0.6.0

What's Changed

Dependencies

• ⬆️ Python v3.9-3.12 by @chrisjsewell in #186
• ⬆️ Octicon icons to v19.8.0 by @ffvpor in #171

New

✨ Create custom directives

You can use the sd_custom_directives configuration option in your conf.py to add custom directives, with default option values:

sd_custom_directives = {
  "dropdown-syntax": {
    "inherit": "dropdown",
    "argument": "Syntax",
    "options": {
      "color": "primary",
      "icon": "code",
    },
  }
}

The key is the new directive name to add, and the value is a dictionary with the following keys:

• inherit: The directive to inherit from (e.g. dropdown)
• argument: The default argument (optional, only for directives that take a single argument)
• options: A dictionary of default options for the directive (optional)

by @chrisjsewell in #194

✨ sync tabs by URL query parameters

Synchronised tabs can now be selected by adding a query parameter to the URL, for that sync-group, such as ?code=python for

.. tab-set-code::

    .. literalinclude:: snippet.py
        :language: python

    .. literalinclude:: snippet.js
        :language: javascript

The last selected tab key, per group, is also persisted SessionStorage

by @mikemckiernan and @chrisjsewell in #196

Improve

• 👌 Use reference name by default for internal link cards by @gabalafou in #183
• 👌 Improve specificity of JS function name by @danirus in #153
• 👌 Remove duplicate CSS hashing for sphinx >= 7.1 by @chrisjsewell in #193

👌 Improve dropdown title bar

There are three visible changes:

1. The "default" behaviour of the right chevron is to go from right-facing (closed) to down-facing (open), instead of down-facing (closed) to up-facing (open). There is also a rotate transition on opening/closing.
   The old default behaviour can be retained by using the new :chevron: down-up directive option.
2. The prefix icon (optional), title text, and chevron state icon are now all better aligned
3. The top/bottom padding is now 0.5em instead of 1em

The PR also introduces three new CSS variables to control font sizes of the dropdown:

--sd-fontsize-tabs-label: 1rem;
--sd-fontsize-dropdown-title: 1rem;
--sd-fontweight-dropdown-title: 700;

Internally, the HTML / CSS is changed, such that the title is now an inline-flex box, with three columns arranged with justify-content: space-between:

icon (optional)	text (flex-grow: 1)	state chevron

Also, the state chevron was previously two distinct SVGs (with one hidden), but now is one that get rotated on open/close.

by @chrisjsewell in #192

Fix

• 🐛 Fix tab-item label with nested syntax by @Praecordi in #135
• 🐛 Fix do not close input tag by @chrisjsewell in #195

Internal

• 📚 Update theme versions by @chrisjsewell in #189

• 📚 Make octicon list a table by @chrisjsewell in #188

• 📚 Add sphinx-immaterial to doc theme builds by @chrisjsewell in #190

• 📚 Change syntax dropdown color by @chrisjsewell in #191

• 🔧 Add FIPS compliant flag to md5 call by @gabor-varga in #162

• 🔧 define build.os for RTD to fix build by @sciencewhiz in #176

• 🔧 Move to ruff by @chrisjsewell in #185

New Contributors

• @danirus made their first contribution in #153
• @sciencewhiz made their first contribution in #176
• @ffvpor made their first contribution in #171
• @Praecordi made their first contribution in #135
• @gabor-varga made their first contribution in #162
• @gabalafou made their first contribution in #183

Full Changelog: v0.5.0...v0.6.0

v0.5.0

What's Changed

• ⬆️ Drop Python 3.7 support, by @chrisjsewell in #146
• ⬆️ UPGRADE: sphinx>=5,<8, by @chrisjsewell in #148

Full Changelog: v0.4.1...v0.5.0

v0.4.1

This is a minor release to bring in the following PR:

• ENH: Add img-alt for card and grid-item-card by @jpmckinney in #114

v0.4.0

v0.4.0 - 2023-04-13

(full changelog)

This release primarily brings in support for the latest versions of Sphinx and Python, and implements a few enhancements and bugfixes as well.

Enhancements made

• Make default blue color a11y friendly. #124 (@feanil, @choldgraf)
• Make card titles translatable #113 (@jpmckinney, @chrisjsewell)

Version upgrades

• Sphinx 6.x. #106 (@marxin, @choldgraf, @srideep3, @jpmckinney, @akaszynski, @benjaoming, @codecov-commenter, @spoorcc, @nicoa, @LecrisUT)
• Support for Python 3.11 #105 (@tirthasheshpatel, @choldgraf, @jpmckinney, @codecov-commenter)

Contributors to this release

The following people contributed discussions, new ideas, code and documentation contributions, and review.
See our definition of contributors.

(GitHub contributors page for this release)

@akaszynski (activity) | @bastimeyer (activity) | @benjaoming (activity) | @choldgraf (activity) | @chrisjsewell (activity) | @codecov-commenter (activity) | @feanil (activity) | @jpmckinney (activity) | @LecrisUT (activity) | @marxin (activity) | @mikemckiernan (activity) | @nicoa (activity) | @pre-commit-ci (activity) | @spoorcc (activity) | @srideep3 (activity) | @tirthasheshpatel (activity) | @zerocewl (activity)

v0.3.0

What's Changed

• ⬆️ Update Materials Design Icons to v4.0.0-46-gc9e5528 by @2bndy5 in #69
• 📚 DOCS: Update font awesome icons by @2bndy5 in #64
• 🐛 FIX: Docs build against non-html formats by @chrisjsewell in #88
• 👌 IMPROVE: Add link-alt to fix card link accessibility by @chrisjsewell in #89
• 🐛 FIX: dropdown/tab-item :name: options by @chrisjsewell in #91
• 👌 IMPROVE: Add card options class-img-top/class-img-bottom by @chrisjsewell in #92
• 👌 IMPROVE: Make tab ids deterministic by @chrisjsewell in #93
• 🔧 MAINTAIN: Fix docutils PendingDeprecationWarning by @chrisjsewell in #94
• 🚀 RELEASE: v0.3.0 by @chrisjsewell in #95

Full Changelog: v0.2.0...v0.3.0

v0.2.0

What's Changed

• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in #63
• ⬆️ Add Python 3.10 support by @jarrodmillman in #71
• ⬆️ Support Sphinx v5, drop v3 by @chrisjsewell in #74
• 🚀 RELEASE: v0.2.0 by @chrisjsewell in #75

New Contributors

• @jarrodmillman made their first contribution in #71

Full Changelog: v0.1.0...v0.2.0

v0.1.0

What's Changed

• ⬆️ UPGRADE: octicons to v16.1.1 by @pocek in #43
• ✨ NEW: Add material design icons roles by @2bndy5 in #41
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in #39
• 🔧 MAINTAIN: Move from setuptools to flit for package build by @chrisjsewell in #58
• 🔧 MAINTAIN: Drop furo-specific stylesheet by @pradyunsg in #22
• 🐛 FIX: Links in card titles by @chrisjsewell in #59
• 🐛 FIX: Exception on missing card link by @chrisjsewell in #60
• 🚀 RELEASE: v0.1.0 by @chrisjsewell in #62

New Contributors

• @pocek made their first contribution in #43
• @2bndy5 made their first contribution in #41

Full Changelog: v0.0.13...v0.1.0

v0.0.13

See CHANGELOG.md

v0.0.12

🚀 RELEASE: v0.0.12

v0.0.11

🚀 RELEASE: v0.0.11