Change Log

0.6.0 - 2024-05-23

Dependencies

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 PR #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 to SessionStorage

by @mikemckiernan and @chrisjsewell in PR #196

Improve

πŸ‘Œ 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 PR #192

Fix

Internal

Full Changelog: https://github.com/executablebooks/sphinx-design/compare/v0.5.0…v0.6.0

0.5.0 - 2023-07-27

Full Changelog: https://github.com/executablebooks/sphinx-design/compare/v0.4.1…v0.5.0

v0.4.0 - 2023-04-13

Full Changelog: https://github.com/executablebooks/sphinx-design/compare/v0.3.0…v0.4.0

Enhancements made

Version upgrades

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)

v0.3.0 - 2022-08-22

  • ⬆️ Update Materials Design Icons to v4.0.0-46-gc9e5528, thanks to @2bndy5 (PR #69)

  • πŸ› FIX: dropdown/tab-item :name: options (PR #91)

  • πŸ› FIX: Docs build against non-html formats (PR #88)

  • πŸ‘Œ IMPROVE: Add card options class-img-top/class-img-bottom (PR #92)

  • πŸ‘Œ IMPROVE: Add link-alt to fix card link accessibility (PR #89)

    • adds the link-alt option to card (and grid-item-card) directives, in order to assign a discernable name to the link (for screen readers).

  • πŸ‘Œ IMPROVE: Make tab ids deterministic (PR #93)

    • Use increasing indices, rather than UUIDs

  • πŸ”§ MAINTAIN: Fix docutils PendingDeprecationWarning (PR #94)

  • πŸ“š DOCS: Update font awesome icons (PR #64)

Full Changelog: https://github.com/executablebooks/sphinx-design/compare/v0.2.0…v0.3.0

v0.2.0 - 2022-06-14

  • ⬆️ Support Sphinx v5, drop v3

  • ⬆️ Add Python 3.10 support

Full Changelog: https://github.com/executablebooks/sphinx-design/compare/v0.1.0…v0.2.0

v0.1.0 - 2022-04-21

Full Changelog: https://github.com/executablebooks/sphinx-design/compare/v0.0.13…v0.1.0

v0.0.13 - 2021-10-27

✨ NEW: add icon far role (PR #35), thanks to @OriolAbril

πŸ‘Œ IMPROVE: Styling for tabs (PR #21), thanks to @pradyunsg

πŸ‘Œ IMPROVE: Properly remove the border on dropdown card body (PR #23), thanks to @pradyunsg

πŸ› FIX: sd-outline-* classes color (PR #25)

v0.0.11 - 2021-09-08

✨ NEW: Add ref-type option to button-ref directive

v0.0.10 - 2021-08-08

✨ NEW: Add grid-item directive child-direction and child-align options

✨ NEW: Add card directive img-background option

v0.0.9 - 2021-06-08

♻️ REFACTOR: test_sd_hide_root_title to sd_hide_title front-matter

πŸ‘Œ IMPROVE: dropdown chevrons

v0.0.8 - 2021-06-08

✨ NEW: Add test_sd_hide_root_title config option to hide the root title.

πŸ‘Œ IMPROVE: sd-card-hover:hover add scale 101%

πŸ“š DOCS: Update landing page

v0.0.7 - 2021-05-08

✨ NEW: Add reverse option for grid directive

✨ NEW: Add animations

v0.0.6 - 2021-04-08

✨ NEW: Add card-carousel directive

v0.0.5 - 2021-28-07

πŸ‘Œ IMPROVE: Make octicon’s size variable

v0.0.4 - 2021-28-07

πŸ‘Œ IMPROVE: Allow auto for grid columns

v0.0.3 - 2021-26-07

πŸ‘Œ IMPROVE: Add more CSS classes and add documentation πŸ“š

v0.0.2 - 2021-23-07

Improve documentation πŸ“š

v0.0.1 - 2021-22-07

Initial release πŸŽ‰