search

edgi-govdata-archiving / web-monitoring-diff

Tools for diffing and comparing web content. Also includes a web server that makes diffs available as an HTTP service.
https://web-monitoring-diff.readthedocs.io/
GNU General Public License v3.0
11 stars 4 forks source link

Update sphinx requirement from ~=4.3.2 to ~=5.1.1 #116

Closed dependabot[bot] closed 2 years ago

dependabot[bot] commented 2 years ago

Updates the requirements on sphinx to permit the latest version.

Release notes

Sourced from sphinx's releases.

v5.1.1

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

Changelog

Sourced from sphinx's changelog.

Release 5.1.1 (released Jul 26, 2022)

Bugs fixed

  • #10701: Fix ValueError in the new deque based sphinx.ext.napolean iterator implementation.
  • #10702: Restore compatability with third-party builders.

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.

... (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)
Mr0grog commented 2 years ago

@dependabot rebase

Mr0grog commented 2 years ago

There’s an incompatibility between Sphinx 5 and Flake8 that prevents this upgrade. Both have reasonable reasons for the constraints they’ve made, but it means we can’t update unless we make the minimum Python version here at lease 3.8 (possibly higher, not sure), or if we separate the linting and docs tools into separate environments, which makes development a bit of a pain.

At the moment, most of our web-monitoring packages are still locked to Python 3.7 in order to support usage on Google Colab. We’re getting along just fine with Sphinx 4.5, so I think I’m just going to skip this update for now.

dependabot[bot] commented 2 years ago

OK, I won't notify you again about this release, but will get in touch when a new version is available. If you'd rather skip all updates until the next major or minor version, let me know by commenting @dependabot ignore this major version or @dependabot ignore this minor version. You can also ignore all major, minor, or patch releases for a dependency by adding an ignore condition with the desired update_types to your config file.

If you change your mind, just re-open this PR and I'll resolve any conflicts on it.