Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update sphinx requirement from <5.1.0,>=4.2.0 to >=4.2.0,<6.1.0 #696

Merged
merged 1 commit into from Jan 3, 2023

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Dec 30, 2022

Updates the requirements on sphinx to permit the latest version.

Release notes

Sourced from sphinx's releases.

v6.0.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Changelog

Sourced from sphinx's changelog.

Release 6.0.0 (released Dec 29, 2022)

Dependencies

  • #10468: Drop Python 3.6 support
  • #10470: Drop Python 3.7, Docutils 0.14, Docutils 0.15, Docutils 0.16, and Docutils 0.17 support. Patch by Adam Turner

Incompatible changes

  • #7405: Removed the jQuery and underscore.js JavaScript frameworks.

    These frameworks are no longer be automatically injected into themes from Sphinx 6.0. If you develop a theme or extension that uses the jQuery, $, or $u global objects, you need to update your JavaScript to modern standards, or use the mitigation below.

    The first option is to use the sphinxcontrib.jquery_ extension, which has been developed by the Sphinx team and contributors. To use this, add sphinxcontrib.jquery to the extensions list in conf.py, or call app.setup_extension("sphinxcontrib.jquery") if you develop a Sphinx theme or extension.

    The second option is to manually ensure that the frameworks are present. To re-add jQuery and underscore.js, you will need to copy jquery.js and underscore.js from the Sphinx repository_ to your static directory, and add the following to your layout.html:

    .. code-block:: html+jinja

    {%- block scripts %} {{ super() }} {%- endblock %}

    .. _sphinxcontrib.jquery: https://github.com/sphinx-contrib/jquery/

    Patch by Adam Turner.

  • #10471, #10565: Removed deprecated APIs scheduled for removal in Sphinx 6.0. See :ref:dev-deprecated-apis for details. Patch by Adam Turner.

  • #10901: C Domain: Remove support for parsing pre-v3 style type directives and roles. Also remove associated configuration variables c_allow_pre_v3 and c_warn_on_allowed_pre_v3. Patch by Adam Turner.

Features added

... (truncated)

Commits

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

Updates the requirements on [sphinx](https://github.com/sphinx-doc/sphinx) to permit the latest version.
- [Release notes](https://github.com/sphinx-doc/sphinx/releases)
- [Changelog](https://github.com/sphinx-doc/sphinx/blob/master/CHANGES)
- [Commits](sphinx-doc/sphinx@v4.2.0...v6.0.0)

---
updated-dependencies:
- dependency-name: sphinx
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Dec 30, 2022
@codecov-commenter
Copy link

codecov-commenter commented Dec 30, 2022

Codecov Report

Merging #696 (67bcf3d) into master (adc03fe) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #696   +/-   ##
=======================================
  Coverage   79.76%   79.76%           
=======================================
  Files         131      131           
  Lines        9133     9133           
=======================================
  Hits         7285     7285           
  Misses       1848     1848           
Flag Coverage Δ
macos-latest-3.10 76.95% <ø> (ø)
ubuntu-latest-3.10 79.65% <ø> (ø)
ubuntu-latest-3.7 79.55% <ø> (ø)
ubuntu-latest-3.8 79.59% <ø> (ø)
ubuntu-latest-3.9 79.59% <ø> (ø)
windows-latest-3.9 76.88% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@ascillitoe
Copy link
Contributor

ascillitoe commented Jan 3, 2023

The issues experienced in #571 appear to be fixed with the latest sphinx and nbsphinx versions. CI passes and random checks on the compiled docs also look OK. 👍🏻

@ascillitoe ascillitoe merged commit a893f51 into master Jan 3, 2023
@dependabot dependabot bot deleted the dependabot/pip/sphinx-gte-4.2.0-and-lt-6.1.0 branch January 3, 2023 12:34
ascillitoe added a commit that referenced this pull request Jan 11, 2023
* Revert "Remove `requirements/docs.txt` comment"

This reverts commit 1c9942d.

* Revert "Update sphinx-autodoc-typehints requirement (#699)"

This reverts commit 87fa4ef.

* Revert "Update sphinx requirement from <5.1.0,>=4.2.0 to >=4.2.0,<6.1.0 (#696)"

This reverts commit a893f51.

* Bump sphinx to <6.0.0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants