-
Notifications
You must be signed in to change notification settings - Fork 229
Move sphinx-gallery as an optional dependency for testing #2439
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
Conversation
a96ff7e
to
c7ad302
Compare
c7ad302
to
87ea242
Compare
f533c3e
to
756d6d4
Compare
1810c0b
to
fa684fd
Compare
Actually, the CI fails to install the GMT dev version from conda-forge on Windows. Perhaps we need to build a new dev version on conda-forge?
|
Ping @weiji14 for review |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually, the CI fails to install the GMT dev version from conda-forge on Windows. Perhaps we need to build a new dev version on conda-forge?
New GMT 6.5.0 dev version PR at conda-forge/gmt-feedstock#248.
Description of proposed changes
Sphinx-Gallery is a required dependency for building the PyGMT documentation. Since we write our own PyGMT scraper and we have a test for it (https://github.com/GenericMappingTools/pygmt/blob/main/pygmt/tests/test_sphinx_gallery.py), it's also required for the PyGMT tests, but it should be an optional dependency for testing.
What this PR does:
Doctests
workflow: removesphinx-gallery
because it's not neededTests
workflow: movesphinx-gallery
as an optional dependency, thus sphinx-gallery is not installed in the Python 3.9 job but is installed in the Python 3.11 workflow.Tests Legacy
workflow, removesphinx-gallery
because I think we don't care whetherPyGMTScraper
works with Python 3.9 but I keep it in theTests Dev
workflowSince
sphinx-gallery
is optional when running the tests, we need to usetry-except
clause to check ifsphinx-gallery
is installed (see the changes inpygmt/sphinx_gallery.py
).This PR reverts some changes in #1525.
The "GMT Dev Tests" workflow failures are tracked in #2511.
Reminders
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
.Slash Commands
You can write slash commands (
/command
) in the first line of a comment to performspecific operations. Supported slash commands are:
/format
: automatically format and lint the code/test-gmt-dev
: run full tests on the latest GMT development version