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,<5.2.0 #571

Closed

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Jul 26, 2022

Updates the requirements on sphinx to permit the latest version.

Release notes

Sourced from sphinx's releases.

v5.1.0

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

Changelog

Sourced from sphinx's changelog.

Release 5.1.0 (released Jul 24, 2022)

Dependencies

  • #10656: Support Docutils 0.19_. Patch by Adam Turner.

.. _Docutils 0.19: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-19-2022-07-05

Deprecated

  • #10467: Deprecated sphinx.util.stemmer in favour of snowballstemmer. Patch by Adam Turner.
  • #9856: Deprecated sphinx.ext.napoleon.iterators.

Features added

  • #10444: html theme: Allow specifying multiple CSS files through the stylesheet setting in theme.conf or by setting html_style to an iterable of strings.
  • #10366: std domain: Add support for emphasising placeholders in :rst:dir:option directives through a new :confval:option_emphasise_placeholders configuration option.
  • #10439: std domain: Use the repr of some variables when displaying warnings, making whitespace issues easier to identify.
  • #10571: quickstart: Reduce content in the generated conf.py file. Patch by Pradyun Gedam.
  • #10648: LaTeX: CSS-named-alike additional :ref:'sphinxsetup' <latexsphinxsetup> keys allow to configure four separate border-widths, four paddings, four corner radii, a shadow (possibly inset), colours for border, background, shadow for each of the code-block, topic, attention, caution, danger, error and warning directives.
  • #10655: LaTeX: Explain non-standard encoding in LatinRules.xdy
  • #10599: HTML Theme: Wrap consecutive footnotes in an <aside> element when using Docutils 0.18 or later, to allow for easier styling. This matches the behaviour introduced in Docutils 0.19. Patch by Adam Turner.
  • #10518: config: Add include_patterns as the opposite of exclude_patterns. Patch by Adam Turner.

Bugs fixed

  • #10594: HTML Theme: field term colons are doubled if using Docutils 0.18+
  • #10596: Build failure if Docutils version is 0.18 (not 0.18.1) due to missing Node.findall()
  • #10506: LaTeX: build error if highlighting inline code role in figure caption (refs: #10251)
  • #10634: Make -P (pdb) option work better with exceptions triggered from events

... (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/5.x/CHANGES)
- [Commits](sphinx-doc/sphinx@v4.2.0...v5.1.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 Jul 26, 2022
@ascillitoe ascillitoe mentioned this pull request Jul 26, 2022
@ascillitoe
Copy link
Contributor

ascillitoe commented Jul 26, 2022

Failing due to this: sphinx-doc/sphinx#10701

The 5.1.1 fix is expected soon.

Edit: a fix has now been release in 5.1.1: sphinx-doc/sphinx#10709. There still appears to be another test failure in the latex build. This needs further investigation...

@ascillitoe
Copy link
Contributor

@dependabot recreate

@ascillitoe ascillitoe changed the title Update sphinx requirement from <5.1.0,>=4.2.0 to >=4.2.0,<5.2.0 [DO NOT MERGE] Update sphinx requirement from <5.1.0,>=4.2.0 to >=4.2.0,<5.2.0 Jul 29, 2022
@ascillitoe
Copy link
Contributor

The latex build might be failing because of this:

spatialaudio/nbsphinx#656

We should rerun the CI for this PR once a patch for nbsphinx has been released.

@ascillitoe ascillitoe added the DO NOT MERGE Do not merge this PR label Aug 10, 2022
@ascillitoe ascillitoe changed the title [DO NOT MERGE] Update sphinx requirement from <5.1.0,>=4.2.0 to >=4.2.0,<5.2.0 Update sphinx requirement from <5.1.0,>=4.2.0 to >=4.2.0,<5.2.0 Aug 10, 2022
@dependabot @github
Copy link
Contributor Author

dependabot bot commented on behalf of github Sep 26, 2022

Superseded by #631.

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 DO NOT MERGE Do not merge this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant