Skip to content

Commit

Permalink
Update sphinx requirement from <6,>=4.4.0 to >=4.4.0,<7 (#2430)
Browse files Browse the repository at this point in the history
Updates the requirements on
[sphinx](/~https://github.com/sphinx-doc/sphinx) to permit the latest
version.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="/~https://github.com/sphinx-doc/sphinx/releases">sphinx's
releases</a>.</em></p>
<blockquote>
<h2>v6.0.0</h2>
<p>Changelog: <a
href="https://www.sphinx-doc.org/en/master/changes.html">https://www.sphinx-doc.org/en/master/changes.html</a></p>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="/~https://github.com/sphinx-doc/sphinx/blob/master/CHANGES">sphinx's
changelog</a>.</em></p>
<blockquote>
<h1>Release 6.0.0 (released Dec 29, 2022)</h1>
<h2>Dependencies</h2>
<ul>
<li><a
href="https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/10468">#10468</a>:
Drop Python 3.6 support</li>
<li><a
href="https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/10470">#10470</a>:
Drop Python 3.7, Docutils 0.14, Docutils 0.15, Docutils 0.16, and
Docutils 0.17 support. Patch by Adam Turner</li>
</ul>
<h2>Incompatible changes</h2>
<ul>
<li>
<p><a
href="https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/7405">#7405</a>:
Removed the jQuery and underscore.js JavaScript frameworks.</p>
<p>These frameworks are no longer be automatically injected into themes
from
Sphinx 6.0. If you develop a theme or extension that uses the
<code>jQuery</code>, <code>$</code>, or <code>$u</code> global objects,
you need to update your
JavaScript to modern standards, or use the mitigation below.</p>
<p>The first option is to use the sphinxcontrib.jquery_ extension, which
has been
developed by the Sphinx team and contributors. To use this, add
<code>sphinxcontrib.jquery</code> to the <code>extensions</code> list in
<code>conf.py</code>, or call
<code>app.setup_extension(&quot;sphinxcontrib.jquery&quot;)</code> if
you develop a Sphinx theme
or extension.</p>
<p>The second option is to manually ensure that the frameworks are
present.
To re-add jQuery and underscore.js, you will need to copy
<code>jquery.js</code> and
<code>underscore.js</code> from <code>the Sphinx repository</code>_ to
your <code>static</code> directory,
and add the following to your <code>layout.html</code>:</p>
<p>.. code-block:: html+jinja</p>
<p>{%- block scripts %}
<!-- raw HTML omitted --><!-- raw HTML omitted -->
<!-- raw HTML omitted --><!-- raw HTML omitted -->
{{ super() }}
{%- endblock %}</p>
<p>.. _sphinxcontrib.jquery: <a
href="/~https://github.com/sphinx-contrib/jquery/">/~https://github.com/sphinx-contrib/jquery/</a></p>
<p>Patch by Adam Turner.</p>
</li>
<li>
<p><a
href="https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/10471">#10471</a>,
<a
href="https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/10565">#10565</a>:
Removed deprecated APIs scheduled for removal in Sphinx 6.0. See
:ref:<code>dev-deprecated-apis</code> for details. Patch by Adam
Turner.</p>
</li>
<li>
<p><a
href="https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/10901">#10901</a>:
C Domain: Remove support for parsing pre-v3 style type directives and
roles. Also remove associated configuration variables
<code>c_allow_pre_v3</code> and
<code>c_warn_on_allowed_pre_v3</code>. Patch by Adam Turner.</p>
</li>
</ul>
<h2>Features added</h2>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="/~https://github.com/sphinx-doc/sphinx/commit/5b56a231afeb6e96e87871546df3db4463a61c93"><code>5b56a23</code></a>
Bump to 6.0.0 final</li>
<li><a
href="/~https://github.com/sphinx-doc/sphinx/commit/f1d1e9c997da52134a574a963ed6d1b404830ee0"><code>f1d1e9c</code></a>
Update coverage workflow for Tox 4</li>
<li><a
href="/~https://github.com/sphinx-doc/sphinx/commit/66a738c2bfccd7a28788762c20baeb57b00719c3"><code>66a738c</code></a>
Update coverage workflow for new configuration location</li>
<li><a
href="/~https://github.com/sphinx-doc/sphinx/commit/041e5f826894de99da5af0eb5225b69b8084c49e"><code>041e5f8</code></a>
Add test coverage for 'today_fmt' reference substitution (<a
href="https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/10980">#10980</a>)</li>
<li><a
href="/~https://github.com/sphinx-doc/sphinx/commit/da25145d0804240de0351d33697539306f3d10a7"><code>da25145</code></a>
Remove unnecessary conditional import in
<code>sphinx.ext.napoleon</code> (<a
href="https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/11043">#11043</a>)</li>
<li><a
href="/~https://github.com/sphinx-doc/sphinx/commit/45a0ea9fc9f0cc509ff385942c275af02591e490"><code>45a0ea9</code></a>
Migrate coveragepy config into pyproject.toml (<a
href="https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/11025">#11025</a>)</li>
<li><a
href="/~https://github.com/sphinx-doc/sphinx/commit/3ec54f118310119211771133c94f0a836505bb43"><code>3ec54f1</code></a>
Create a <code>pydata_sphinx_theme</code> section in usage examples (<a
href="https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/11046">#11046</a>)</li>
<li><a
href="/~https://github.com/sphinx-doc/sphinx/commit/32bce8fb7c0b7a2eb89c7e0e3e7ef13fce7f03a6"><code>32bce8f</code></a>
Copy edit the tutorial (<a
href="https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/11049">#11049</a>)</li>
<li><a
href="/~https://github.com/sphinx-doc/sphinx/commit/984416247370a87ad947d89f334a8ce2d8ea6558"><code>9844162</code></a>
Fix example using <code>add_config_value</code> (<a
href="https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/10937">#10937</a>)</li>
<li><a
href="/~https://github.com/sphinx-doc/sphinx/commit/bf4a6268268442cc4d6b3bc7c3528bf77ae705db"><code>bf4a626</code></a>
RTD builder: add graphviz depedendency (<a
href="https://github-redirect.dependabot.com/sphinx-doc/sphinx/issues/11040">#11040</a>)</li>
<li>Additional commits viewable in <a
href="/~https://github.com/sphinx-doc/sphinx/compare/v4.4.0...v6.0.0">compare
view</a></li>
</ul>
</details>
<br />


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-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 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>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
  • Loading branch information
dependabot[bot] authored Jan 3, 2023
1 parent 2f2c692 commit 059d988
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ demo = [
"ipython",
]
doc = [
"sphinx>=4.4.0,<6",
"sphinx>=4.4.0,<7",
"myst-parser==0.18.1",
"Jinja2==3.1.2",
"alabaster",
Expand Down

0 comments on commit 059d988

Please sign in to comment.