search

ansys / ansys-sphinx-theme

PyData-based Sphinx theme from the PyAnsys community
https://sphinxdocs.ansys.com
MIT License
21 stars 5 forks source link

chore(deps): bump sphinx-design from 0.5.0 to 0.6.0 #383

Closed dependabot[bot] closed 1 month ago

dependabot[bot] commented 1 month ago

Bumps sphinx-design from 0.5.0 to 0.6.0.

Release notes

Sourced from sphinx-design's releases.

v0.6.0

What's Changed

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 executablebooks/sphinx-design#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

... (truncated)

Changelog

Sourced from sphinx-design's changelog.

0.6.0 - 2024-05-23

Dependencies

  • ⬆️ Python v3.9-3.12 by {user}chrisjsewell in {pr}186
  • ⬆️ Octicon icons to v19.8.0 by {user}ffvpor in {pr}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 {user}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

... (truncated)

Commits


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 show ignore conditions` will show all of the ignore conditions of the specified dependency - `@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)
RobPasMue commented 1 month ago

Raised warning: https://github.com/ansys/ansys-sphinx-theme/actions/runs/9200543036/job/25307298973?pr=383#step:2:1002

RobPasMue commented 1 month ago

@Revathyvenugopal162 could you investigate?

Revathyvenugopal162 commented 1 month ago

@Revathyvenugopal162 could you investigate?

sure, on it

Revathyvenugopal162 commented 1 month ago

We needed to filter the lines in our example because the header of one of the Sphinx design files was incorrect. Now, with the new release, the issue has been resolved, so I removed the filtering code.

MaxJPRey commented 1 month ago

Thank you @Revathyvenugopal162 for the explanations.