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

Ignore config cache warnings in sphinx #1893

Merged
merged 2 commits into from
Apr 25, 2024
Merged

Conversation

stephprince
Copy link
Contributor

Motivation

Fix #1891.

The sphinx_gallery_conf configuration contains classes that are unpickleable and will now warn the user.

We could just ignore these warnings for now, or if we want to change the config I think we will have to wait on some serialization updates from sphinx.

How to test the behavior?

Update sphinx and run the following:

cd docs
make clean && make html

Checklist

  • Did you update CHANGELOG.md with your changes?
  • Have you checked our Contributing document?
  • Have you ensured the PR clearly describes the problem and the solution?
  • Is your contribution compliant with our coding style? This can be checked running flake8 from the source directory.
  • Have you checked to ensure that there aren't other open Pull Requests for the same change?
  • Have you included the relevant issue number using "Fix #XXX" notation where XXX is the issue number? By including "Fix #XXX" you allow GitHub to close issue #XXX when the PR is merged.

@stephprince stephprince changed the title ignore config cache warnings in sphinx Ignore config cache warnings in sphinx Apr 22, 2024
Copy link

codecov bot commented Apr 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.01%. Comparing base (ff1a03c) to head (82df9e2).

Additional details and impacted files
@@           Coverage Diff           @@
##              dev    #1893   +/-   ##
=======================================
  Coverage   92.01%   92.01%           
=======================================
  Files          27       27           
  Lines        2619     2619           
  Branches      685      685           
=======================================
  Hits         2410     2410           
  Misses        139      139           
  Partials       70       70           
Flag Coverage Δ
integration 72.81% <ø> (ø)
unit 83.92% <ø> (ø)

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

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

@stephprince stephprince requested a review from oruebel April 22, 2024 18:52
@rly
Copy link
Contributor

rly commented Apr 25, 2024

Let's ignore the warning for now

@rly rly mentioned this pull request Apr 25, 2024
11 tasks
@stephprince stephprince enabled auto-merge (squash) April 25, 2024 18:48
@stephprince stephprince merged commit 54b42b4 into dev Apr 25, 2024
21 of 23 checks passed
@stephprince stephprince deleted the ignore-config-cache-warnings branch April 25, 2024 19:06
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.

[Bug]: Check sphinx links workflow failing because of new sphinx warning
2 participants