Skip to content

Remove upper limit on sphinx-gallery and specify documentation-related requirements#2019

Merged
namurphy merged 2 commits into
PlasmaPy:mainfrom
namurphy:update-sphinx-gallery
Mar 15, 2023
Merged

Remove upper limit on sphinx-gallery and specify documentation-related requirements#2019
namurphy merged 2 commits into
PlasmaPy:mainfrom
namurphy:update-sphinx-gallery

Conversation

@namurphy

@namurphy namurphy commented Mar 14, 2023

Copy link
Copy Markdown
Member

Previously, we placed an upper limit on sphinx-gallery because using the newer version led to the thumbnails for our example galleries to show up incorrectly. This PR removes the upper limit on sphinx-gallery.

This PR also sets some new minimum versions of packages for building the documentation, since it may be updates to sphinx_rtd_theme or nbsphinx that are what fixed the problem. It's worth noting that the new requirements for several of these packages are for the most recent release, but since this is for optional requirements for the documentation, I don't expect this to cause any problems.

Related to #1654. Closes #1972.

@namurphy namurphy added the no changelog entry needed For PRs that should not have a changelog entry label Mar 14, 2023
@codecov

codecov Bot commented Mar 15, 2023

Copy link
Copy Markdown

Codecov Report

Patch and project coverage have no change.

Comparison is base (2decb70) 98.33% compared to head (ce734bf) 98.33%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2019   +/-   ##
=======================================
  Coverage   98.33%   98.33%           
=======================================
  Files          96       96           
  Lines        8503     8503           
=======================================
  Hits         8361     8361           
  Misses        142      142           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@namurphy namurphy changed the title Remove upper limit on sphinx-gallery Remove upper limit on sphinx-gallery and specify documentation-related requirements Mar 15, 2023
@namurphy

Copy link
Copy Markdown
Member Author

The examples page for the Read the Docs documentation build for this pull request appear to be fine, so this PR should be good to go!

@namurphy namurphy marked this pull request as ready for review March 15, 2023 00:56
@namurphy namurphy requested review from a team and StanczakDominik as code owners March 15, 2023 00:56

@ejohnson-96 ejohnson-96 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good :)

@namurphy namurphy merged commit 31fd439 into PlasmaPy:main Mar 15, 2023
@namurphy

Copy link
Copy Markdown
Member Author

Thanks for the review!

@namurphy namurphy deleted the update-sphinx-gallery branch March 15, 2023 19:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no changelog entry needed For PRs that should not have a changelog entry

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Remove upper limit on sphinx-gallery

2 participants