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 gallery pin #6034

Merged
merged 1 commit into from
Nov 15, 2021
Merged

Conversation

hmaarrfk
Copy link
Member

Description

Closes #6030

Checklist

  • Docstrings for all functions
  • Gallery example in ./doc/examples (new features only)
  • Benchmark in ./benchmarks, if your changes aren't covered by an
    existing benchmark
  • Unit tests
  • Clean style in the spirit of PEP8
  • Descriptive commit messages (see below)

For reviewers

  • Check that the PR title is short, concise, and will make sense 1 year
    later.
  • Check that new functions are imported in corresponding __init__.py.
  • Check that new features, API changes, and deprecations are mentioned in
    doc/release/release_dev.rst.

Comment on lines 1 to 3
sphinx>=1.8
# sphinx-gallery 0.10.0 broke support for Sphinx >=4.3.0
sphinx-gallery>=0.7.0,!=0.8.0,!=0.10.0
Copy link
Member

@jni jni Nov 15, 2021

Choose a reason for hiding this comment

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

@hmaarrfk I don't think this is correct: I think any version of sphinx-gallery prior to 0.10.1 will break with new sphinx. ie we need:

sphinx>=1.8,<4.3
sphinx-gallery

OR

sphinx>=1.8
sphinx-gallery>=0.10.1

I don't think pip lets one specify such complex dependencies, so I think we should just bite the bullet and depend on sphinx-gallery 0.10.1+.

Copy link
Member Author

Choose a reason for hiding this comment

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

hmmm. ok. let's see what the latest builds say. i guess I'm building 0.9 and 4.3 now and we can check the compatibility issues.

otherwise, i agree that we should depend on 0.10.1+

Copy link
Member Author

Choose a reason for hiding this comment

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

Seems like you are right. I added a comment in case downstream wants to rebuild docs (not sure who does that) but let me know if there is anything else.

@grlee77
Copy link
Contributor

grlee77 commented Nov 15, 2021

don't know what is going on with that mini-req case failure on GHA.
The Azure failure is related to #6019
neither seems related to the changes in this PR

@grlee77 grlee77 changed the title Update sphinx gallery pin, Update sphinx gallery pin Nov 15, 2021
@grlee77 grlee77 merged commit d5de9fd into scikit-image:main Nov 15, 2021
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.

Sphinx 4.3.0 broke documentation generation; unpin when resolved
3 participants