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

Dependencies: Pin requirement sphinx~=7.2.0 #6527

Merged
merged 1 commit into from
Jul 16, 2024

Conversation

sphuber
Copy link
Contributor

@sphuber sphuber commented Jul 15, 2024

The recently released v7.4.0 causes the build of the documentation to fail with warnings of the type:

Failed to get a method signature for ...: unhashable type

Copy link

codecov bot commented Jul 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.82%. Comparing base (ef60b66) to head (f40198c).
Report is 116 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #6527      +/-   ##
==========================================
+ Coverage   77.51%   77.82%   +0.32%     
==========================================
  Files         560      564       +4     
  Lines       41444    41918     +474     
==========================================
+ Hits        32120    32619     +499     
+ Misses       9324     9299      -25     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@sphuber
Copy link
Contributor Author

sphuber commented Jul 15, 2024

See bug report at Sphinx: sphinx-doc/sphinx#12579
Note that downgrading to v7.3.7 does not work as that has a different bug: sphinx-doc/sphinx#12580
This does not seem to be present in v7.3.6, but for simplicity now just pinning to the v7.2 minor series.

Edit: The original bugs mentioned above have been fixed in releases v7.4.1 and v7.4.2 respectively, however, there are still two new warnings

WARNING: inventory <https://docs.sqlalchemy.org/en/14/> contains multiple definitions for std:term:crud
WARNING: inventory <https://docs.sqlalchemy.org/en/14/> contains multiple definitions for std:term:expiring

This is also likely due to the v7.4 release.

The recently released v7.4.0 causes the build of the documentation to
fail with warnings of the type:

    Failed to get a method signature for ...: unhashable type

It also leads to issues with incremental builds where it fails if
a build exists that was generated with an older version.

Both these bugs were fixed in v7.4.1 and v7.4.2 respectively, but more
warnings remain. Instead of waiting for these to be fixed, we are just
pinning to a minor version here which should anyway be done for optional
dev dependencies. There is no need to automatically update those to
latest releases.
@sphuber sphuber changed the title Dependencies: Pin requirement sphinx~=7.2.1 Dependencies: Pin requirement sphinx~=7.2.0 Jul 16, 2024
@sphuber sphuber merged commit a610460 into aiidateam:main Jul 16, 2024
29 checks passed
@sphuber sphuber deleted the fix/sphinx-dependency branch July 16, 2024 10:21
sphuber added a commit that referenced this pull request Aug 7, 2024
The recently released v7.4.0 causes the build of the documentation to
fail with warnings of the type:

    Failed to get a method signature for ...: unhashable type

It also leads to issues with incremental builds where it fails if
a build exists that was generated with an older version.

Both these bugs were fixed in v7.4.1 and v7.4.2 respectively, but more
warnings remain. Instead of waiting for these to be fixed, we are just
pinning to a minor version here which should anyway be done for optional
dev dependencies. There is no need to automatically update those to
latest releases.

Cherry-pick: a610460
mikibonacci pushed a commit to mikibonacci/aiida-core that referenced this pull request Sep 3, 2024
…team#6527)

The recently released v7.4.0 causes the build of the documentation to
fail with warnings of the type:

    Failed to get a method signature for ...: unhashable type

It also leads to issues with incremental builds where it fails if
a build exists that was generated with an older version.

Both these bugs were fixed in v7.4.1 and v7.4.2 respectively, but more
warnings remain. Instead of waiting for these to be fixed, we are just
pinning to a minor version here which should anyway be done for optional
dev dependencies. There is no need to automatically update those to
latest releases.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant