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

Bump sphinx from 4.5.0 to 5.1.0 #1149

Merged
merged 7 commits into from
Jul 31, 2022
Merged

Conversation

dependabot[bot]
Copy link
Contributor

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

Bumps sphinx from 4.5.0 to 5.1.0.

Release notes

Sourced from sphinx's releases.

v5.1.0

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

v5.0.2

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

v5.0.1

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

v5.0.0

No release notes provided.

v5.0.0b1

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

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)

Bumps [sphinx](https://github.com/sphinx-doc/sphinx) from 4.5.0 to 5.1.0.
- [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.5.0...v5.1.0)

---
updated-dependencies:
- dependency-name: sphinx
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added the skip news Skip CI check for news/changelog label Jul 24, 2022
@dependabot dependabot bot requested a review from cooperlees July 24, 2022 18:17
@codecov
Copy link

codecov bot commented Jul 24, 2022

Codecov Report

Merging #1149 (127b2a9) into main (b0779c7) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1149   +/-   ##
=======================================
  Coverage   83.38%   83.38%           
=======================================
  Files          31       31           
  Lines        4218     4218           
  Branches      662      662           
=======================================
  Hits         3517     3517           
  Misses        523      523           
  Partials      178      178           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b0779c7...127b2a9. Read the comment docs.

@cooperlees
Copy link
Contributor

The conflict is caused by:
    The user requested sphinx==5.1.0
    myst-parser 0.17.2 depends on sphinx<5 and >=3.1

Need to update to myst-parser 0.18.0

@cooperlees
Copy link
Contributor

sphinx-doc/sphinx#10613 - Seems related with issues we're getting ...

@dependabot @github
Copy link
Contributor Author

dependabot bot commented on behalf of github Jul 29, 2022

A newer version of sphinx exists, but since this PR has been edited by someone other than Dependabot I haven't updated it. You'll get a PR for the updated version as normal once this PR is merged.

Copy link
Contributor

@cooperlees cooperlees left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like we've got there ... Building docs again.

@cooperlees cooperlees merged commit 9a04272 into main Jul 31, 2022
@cooperlees cooperlees deleted the dependabot/pip/sphinx-5.1.0 branch July 31, 2022 00:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip news Skip CI check for news/changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant