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

[Dependabot]: Update sphinx requirement from ~=8.1 to ~=8.2 #49

Closed
wants to merge 1 commit into from

Conversation

dependabot[bot]
Copy link

@dependabot dependabot bot commented on behalf of github Feb 19, 2025

Updates the requirements on sphinx to permit the latest version.

Release notes

Sourced from sphinx's releases.

Sphinx 8.2.0

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

Dependencies

  • #13000: Drop Python 3.10 support.

Incompatible changes

  • #13044: Remove the internal and undocumented has_equations data from the MathDomain domain. The undocumented MathDomain.has_equations method now unconditionally returns True. These are replaced by the has_maths_elements key of the page context dict. Patch by Adam Turner.
  • #13227: HTML output for sequences of keys in the kbd role no longer uses a <kbd class="kbd compound"> element to wrap the keys and separators, but places them directly in the relevant parent node. This means that CSS rulesets targeting kbd.compound or .kbd.compound will no longer have any effect. Patch by Adam Turner.

Deprecated

  • #13037: Deprecate the SingleHTMLBuilder.fix_refuris method. Patch by James Addison.
  • #13083, #13330: Un-deprecate sphinx.util.import_object. Patch by Matthias Geier.

Features added

  • #13173: Add a new duplicate_declaration warning type, with duplicate_declaration.c and duplicate_declaration.cpp subtypes. Patch by Julien Lecomte and Adam Turner.
  • #11824: linkcode: Allow extensions to add support for a domain by defining the keys that should be present. Patch by Nicolas Peugnet.
  • #13144: Add a class option to the autosummary directive. Patch by Tim Hoffmann.
  • #13146: Napoleon: Unify the type preprocessing logic to allow Google-style docstrings to use the optional and default keywords. Patch by Chris Barrick.
  • #13227: Implement the kbd role as a SphinxRole. Patch by Adam Turner.
  • #13065: Enable colour by default in when running on CI.

... (truncated)

Changelog

Sourced from sphinx's changelog.

Release 8.2.0 (released Feb 18, 2025)

Dependencies

  • #13000: Drop Python 3.10 support.

Incompatible changes

  • #13044: Remove the internal and undocumented has_equations data from the :py:class:!MathDomain domain. The undocumented :py:meth:!MathDomain.has_equations method now unconditionally returns True. These are replaced by the has_maths_elements key of the page context dict. Patch by Adam Turner.
  • #13227: HTML output for sequences of keys in the :rst:role:kbd role no longer uses a <kbd class="kbd compound"> element to wrap the keys and separators, but places them directly in the relevant parent node. This means that CSS rulesets targeting kbd.compound or .kbd.compound will no longer have any effect. Patch by Adam Turner.

Deprecated

  • #13037: Deprecate the SingleHTMLBuilder.fix_refuris method. Patch by James Addison.
  • #13083, #13330: Un-deprecate sphinx.util.import_object. Patch by Matthias Geier.

Features added

  • #13173: Add a new duplicate_declaration warning type, with duplicate_declaration.c and duplicate_declaration.cpp subtypes. Patch by Julien Lecomte and Adam Turner.
  • #11824: linkcode: Allow extensions to add support for a domain by defining the keys that should be present. Patch by Nicolas Peugnet.
  • #13144: Add a class option to the :rst:dir:autosummary directive. Patch by Tim Hoffmann.
  • #13146: Napoleon: Unify the type preprocessing logic to allow Google-style docstrings to use the optional and default keywords. Patch by Chris Barrick.
  • #13227: Implement the :rst:role:kbd role as a SphinxRole. Patch by Adam Turner.
  • #13065: Enable colour by default in when running on CI. Patch by Adam Turner.

... (truncated)

Commits
  • 78bb5a1 Bump to 8.2.0 final
  • 2f8c1dd Mark autodoc singledispatchmethod tests as expected failures
  • 03ee6b0 Require flit-core 3.10 for Python 3.14
  • 3c324a6 [bot]: Update message catalogues (#13021)
  • b1dc206 Emend typo in CHANGES
  • 23cd5d0 Bump version
  • 684ed56 Bump to 8.2.0 candidate 2
  • 7e73faa Define environment variables in the transifex workflow
  • 552f614 Run the transifex workflow on changes to relevant files
  • 179e242 Add the sphinx.ext.apidoc extension (#13333)
  • Additional commits viewable in compare view

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

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.rst)
- [Commits](sphinx-doc/sphinx@v8.1.0...v8.2.0)

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

Signed-off-by: dependabot[bot] <support@github.com>
Copy link
Author

dependabot bot commented on behalf of github Feb 19, 2025

The following labels could not be found: Dependencies.

@dependabot dependabot bot requested review from Paebbels and umarcor February 19, 2025 22:20
Copy link
Author

dependabot bot commented on behalf of github Feb 20, 2025

Looks like sphinx is up-to-date now, so this is no longer needed.

@dependabot dependabot bot closed this Feb 20, 2025
@dependabot dependabot bot deleted the dependabot/pip/dev/sphinx-approx-eq-8.2 branch February 20, 2025 21:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

0 participants