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 <6.1.0,>=4.2.0 to >=4.2.0,<6.2.0 #700

Closed

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Jan 6, 2023

Updates the requirements on sphinx to permit the latest version.

Release notes

Sourced from sphinx's releases.

v6.1.1

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

Changelog

Sourced from sphinx's changelog.

Release 6.1.1 (released Jan 05, 2023)

Bugs fixed

  • #11091: Fix util.nodes.apply_source_workaround for literal_block nodes with no source information in the node or the node's parents.

Release 6.1.0 (released Jan 05, 2023)

Dependencies

Incompatible changes

  • #10979: gettext: Removed support for pluralisation in get_translation. This was unused and complicated other changes to sphinx.locale.

Deprecated

  • sphinx.util functions:

    • Renamed sphinx.util.typing.stringify() to sphinx.util.typing.stringify_annotation()
    • Moved sphinx.util.xmlname_checker() to sphinx.builders.epub3._XML_NAME_PATTERN

    Moved to sphinx.util.display:

    • sphinx.util.status_iterator
    • sphinx.util.display_chunk
    • sphinx.util.SkipProgressMessage
    • sphinx.util.progress_message

    Moved to sphinx.util.http_date:

    • sphinx.util.epoch_to_rfc1123
    • sphinx.util.rfc1123_to_epoch

    Moved to sphinx.util.exceptions:

    • sphinx.util.save_traceback

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

@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Jan 6, 2023
@dependabot dependabot bot requested review from ascillitoe, jklaise and mauicv January 6, 2023 07:01
@codecov-commenter
Copy link

codecov-commenter commented Jan 6, 2023

Codecov Report

Merging #700 (d994e0d) into master (1c9942d) will increase coverage by 0.02%.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #700      +/-   ##
==========================================
+ Coverage   80.11%   80.13%   +0.02%     
==========================================
  Files         133      133              
  Lines        9177     9177              
==========================================
+ Hits         7352     7354       +2     
+ Misses       1825     1823       -2     
Flag Coverage Δ
ubuntu-latest-3.10 80.04% <ø> (ø)
ubuntu-latest-3.7 79.87% <ø> (ø)
ubuntu-latest-3.9 79.99% <ø> (ø)
windows-latest-3.9 76.58% <ø> (?)

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

Impacted Files Coverage Δ
alibi_detect/utils/frameworks.py 92.59% <0.00%> (+3.70%) ⬆️

@dependabot dependabot bot force-pushed the dependabot/pip/sphinx-gte-4.2.0-and-lt-6.2.0 branch from 4fafdb4 to 257cfa9 Compare January 6, 2023 16:56
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/v6.1.1/CHANGES)
- [Commits](sphinx-doc/sphinx@v4.2.0...v6.1.1)

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

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot force-pushed the dependabot/pip/sphinx-gte-4.2.0-and-lt-6.2.0 branch from 257cfa9 to d994e0d Compare January 6, 2023 17:04
@ascillitoe
Copy link
Contributor

Note: sphinx 6.0 was not being tested when #696 was merged, since sphinx was upper-bounded by other dependencies. 6.0 will only be installed once new sphinx-design (executablebooks/sphinx-design#118) and myst-parser (executablebooks/MyST-Parser#664) versions are released. @jklaise we could revert #696 but I'm wondering if its easier just to check the docs again before merging new versions of sphinx-design etc?

@jklaise
Copy link
Contributor

jklaise commented Jan 9, 2023

@ascillitoe this is getting confusing now, what is the version currently running on CI?

It's rather misleading to have a bound in our deps file which is not true because another dependency pins it lower. That being said, I don't think a simple reversion will work as then we'll be in conflict with sphinx-autodoc-typehints again.

@ascillitoe
Copy link
Contributor

It is confusing indeed. In the CI for the previous dependabot PR (for <6.1.0), sphinx 5.3.0 was installed. In this PR, sphinx 6.1.0 is being installed, but pip is giving incompatible version errors.

This is a much more general error that we have run into a lot now (e.g. with tensorflow bumps); the tested version often doesn't match what dependabot is bumping to due to other deps bounds. I'm not quite sure what the solution is except to be strict about checking the Install dependencies CI step in detail for each dependabot PR (we could add a note in notion or on GitHub?).

@jklaise
Copy link
Contributor

jklaise commented Jan 9, 2023

Ideally we could attach the same note on every PR opened by dependabot (perhaps there's a dependabot or Github setting). Even more ideally we could try to automate this, e.g. find if there is a Github Action that can automatically check the versions of software installed in CI and fail the build if it's not the expected one, probably more tricky.

@dependabot @github
Copy link
Contributor Author

dependabot bot commented on behalf of github Jan 11, 2023

Superseded by #709.

@dependabot dependabot bot closed this Jan 11, 2023
@dependabot dependabot bot deleted the dependabot/pip/sphinx-gte-4.2.0-and-lt-6.2.0 branch January 11, 2023 12:07
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.

3 participants