Skip to content

Commit

Permalink
Update sphinx-design requirement from <0.6,>=0.3 to >=0.3,<0.7 in /re…
Browse files Browse the repository at this point in the history
…quirements (#302)

Updates the requirements on
[sphinx-design](https://github.com/executablebooks/sphinx-design) to
permit the latest version.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/executablebooks/sphinx-design/releases">sphinx-design's
releases</a>.</em></p>
<blockquote>
<h2>v0.6.0</h2>
<h2>What's Changed</h2>
<h3>Dependencies</h3>
<ul>
<li>⬆️ Python v3.9-3.12 by <a
href="https://github.com/chrisjsewell"><code>@​chrisjsewell</code></a>
in <a
href="https://redirect.github.com/executablebooks/sphinx-design/pull/186">executablebooks/sphinx-design#186</a></li>
<li>⬆️ Octicon icons to v19.8.0 by <a
href="https://github.com/ffvpor"><code>@​ffvpor</code></a> in <a
href="https://redirect.github.com/executablebooks/sphinx-design/pull/171">executablebooks/sphinx-design#171</a></li>
</ul>
<h3>New</h3>
<h4>✨ Create custom directives</h4>
<p>You can use the <code>sd_custom_directives</code> configuration
option in your <code>conf.py</code> to add custom directives, with
default option values:</p>
<pre lang="python"><code>sd_custom_directives = {
  &quot;dropdown-syntax&quot;: {
    &quot;inherit&quot;: &quot;dropdown&quot;,
    &quot;argument&quot;: &quot;Syntax&quot;,
    &quot;options&quot;: {
      &quot;color&quot;: &quot;primary&quot;,
      &quot;icon&quot;: &quot;code&quot;,
    },
  }
}
</code></pre>
<p>The key is the new directive name to add, and the value is a
dictionary with the following keys:</p>
<ul>
<li><code>inherit</code>: The directive to inherit from (e.g.
<code>dropdown</code>)</li>
<li><code>argument</code>: The default argument (optional, only for
directives that take a single argument)</li>
<li><code>options</code>: A dictionary of default options for the
directive (optional)</li>
</ul>
<p>by <a
href="https://github.com/chrisjsewell"><code>@​chrisjsewell</code></a>
in <a
href="https://redirect.github.com/executablebooks/sphinx-design/pull/194">executablebooks/sphinx-design#194</a></p>
<h4>✨ sync tabs by URL query parameters</h4>
<p>Synchronised tabs can now be selected by adding a query parameter to
the URL, for that sync-group, such as <code>?code=python</code> for</p>
<pre lang="restructuredtext"><code>.. tab-set-code::
<pre><code>.. literalinclude:: snippet.py
    :language: python

.. literalinclude:: snippet.js
    :language: javascript
</code></pre>
<p></code></pre></p>
<p>The last selected tab key, per group, is also persisted
<code>SessionStorage</code></p>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/executablebooks/sphinx-design/blob/main/CHANGELOG.md">sphinx-design's
changelog</a>.</em></p>
<blockquote>
<h2>0.6.0 - 2024-05-23</h2>
<h3>Dependencies</h3>
<ul>
<li>⬆️ Python v3.9-3.12 by {user}<code>chrisjsewell</code> in
{pr}<code>186</code></li>
<li>⬆️ Octicon icons to v19.8.0 by {user}<code>ffvpor</code> in
{pr}<code>171</code></li>
</ul>
<h3>New</h3>
<h4>✨ Create custom directives</h4>
<p>You can use the <code>sd_custom_directives</code> configuration
option in your <code>conf.py</code> to add custom directives, with
default option values:</p>
<pre lang="python"><code>sd_custom_directives = {
  &quot;dropdown-syntax&quot;: {
    &quot;inherit&quot;: &quot;dropdown&quot;,
    &quot;argument&quot;: &quot;Syntax&quot;,
    &quot;options&quot;: {
      &quot;color&quot;: &quot;primary&quot;,
      &quot;icon&quot;: &quot;code&quot;,
    },
  }
}
</code></pre>
<p>The key is the new directive name to add, and the value is a
dictionary with the following keys:</p>
<ul>
<li><code>inherit</code>: The directive to inherit from (e.g.
<code>dropdown</code>)</li>
<li><code>argument</code>: The default argument (optional, only for
directives that take a single argument)</li>
<li><code>options</code>: A dictionary of default options for the
directive (optional)</li>
</ul>
<p>by {user}<code>chrisjsewell</code> in {pr}<code>194</code></p>
<h4>✨ sync tabs by URL query parameters</h4>
<p>Synchronised tabs can now be selected by adding a query parameter to
the URL, for that sync-group, such as <code>?code=python</code> for</p>
<pre lang="restructuredtext"><code>.. tab-set-code::
<pre><code>.. literalinclude:: snippet.py
    :language: python

.. literalinclude:: snippet.js
    :language: javascript
</code></pre>
<p></code></pre></p>
<p>The last selected tab key, per group, is also persisted to
<code>SessionStorage</code></p>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/executablebooks/sphinx-design/commit/16af1dc83b5da0f8b9b4795d5223be86f8e99b6b"><code>16af1dc</code></a>
🚀 Release v0.6.0 (<a
href="https://redirect.github.com/executablebooks/sphinx-design/issues/197">#197</a>)</li>
<li><a
href="https://github.com/executablebooks/sphinx-design/commit/f1427ce9e87c911552efb9736cc893ae20b55dc5"><code>f1427ce</code></a>
✨ NEW: sync tabs by URL query parameters (<a
href="https://redirect.github.com/executablebooks/sphinx-design/issues/196">#196</a>)</li>
<li><a
href="https://github.com/executablebooks/sphinx-design/commit/a6f97b81ce80806fa13adf647a99e2df71ba1e34"><code>a6f97b8</code></a>
🐛 FIX: do not close <code>input</code> tag (<a
href="https://redirect.github.com/executablebooks/sphinx-design/issues/195">#195</a>)</li>
<li><a
href="https://github.com/executablebooks/sphinx-design/commit/e258b45db466d1c2b62f198c29d2442710dc1a20"><code>e258b45</code></a>
👌 Use reference name by default for internal link cards (<a
href="https://redirect.github.com/executablebooks/sphinx-design/issues/183">#183</a>)</li>
<li><a
href="https://github.com/executablebooks/sphinx-design/commit/3374383d1b0731825b80218ee34472149f4ee80a"><code>3374383</code></a>
✨ NEW: Create custom directives (<a
href="https://redirect.github.com/executablebooks/sphinx-design/issues/194">#194</a>)</li>
<li><a
href="https://github.com/executablebooks/sphinx-design/commit/af64472f83aaaa6cb4763d318bcf11863f331940"><code>af64472</code></a>
🔧 Add FIPS compliant flag to md5 call (<a
href="https://redirect.github.com/executablebooks/sphinx-design/issues/162">#162</a>)</li>
<li><a
href="https://github.com/executablebooks/sphinx-design/commit/074f21fde3ca29644ac6c0a6a94fa37508d16d81"><code>074f21f</code></a>
👌 Remove duplicate CSS hashing for sphinx &gt;= 7.1 (<a
href="https://redirect.github.com/executablebooks/sphinx-design/issues/193">#193</a>)</li>
<li><a
href="https://github.com/executablebooks/sphinx-design/commit/be1b85d9f59cddcc7c7aaf2093362d940a6d4789"><code>be1b85d</code></a>
🐛 Fix tab-item label with nested syntax (<a
href="https://redirect.github.com/executablebooks/sphinx-design/issues/135">#135</a>)</li>
<li><a
href="https://github.com/executablebooks/sphinx-design/commit/89aaa26911f2e1c2cd4c14e6fc7bb0f2a44c0035"><code>89aaa26</code></a>
👌 Improve dropdown title bar (<a
href="https://redirect.github.com/executablebooks/sphinx-design/issues/192">#192</a>)</li>
<li><a
href="https://github.com/executablebooks/sphinx-design/commit/169c09da015d2e22aaa0ef4a1cbd3c101aea7d26"><code>169c09d</code></a>
📚 Change syntax dropdown color (<a
href="https://redirect.github.com/executablebooks/sphinx-design/issues/191">#191</a>)</li>
<li>Additional commits viewable in <a
href="https://github.com/executablebooks/sphinx-design/compare/v0.3.0...v0.6.0">compare
view</a></li>
</ul>
</details>
<br />


You can trigger a rebase of this PR by commenting `@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

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 <dependency name> 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)


</details>

> **Note**
> Automatic rebases have been disabled on this pull request as it has
been open for over 30 days.
  • Loading branch information
Guts authored Jul 1, 2024
2 parents b8be889 + aa5044d commit a110517
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion requirements/documentation.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ myst-parser[linkify]>=0.13,<3.1
sphinx>=3.1,<8
sphinx-autobuild==2024.4.16
sphinx-copybutton>=0.2,<1
sphinx-design>=0.3,<0.6
sphinx-design>=0.6.0,<0.7
sphinx-sitemap>=2.4,<3
toml>=0.10.2

0 comments on commit a110517

Please sign in to comment.