Repository navigation
Use nox for some testing environments in GitHub workflows - #2656
Merged
Merged
Conversation
github-actions
Bot
added
testing
CI
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2656 +/- ##
=======================================
Coverage 95.22% 95.22%
=======================================
Files 103 103
Lines 9401 9401
Branches 2151 2151
=======================================
Hits 8952 8952
Misses 274 274
Partials 175 175 ☔ View full report in Codecov by Sentry. |
This reverts commit fac1f47.
github-actions
Bot
added
the
docs
namurphy
added
the
perform linkcheck in CI
namurphy
marked this pull request as ready for review
May 2, 2024 21:39
namurphy
removed
the
perform linkcheck in CI
For nox.thea.codes
namurphy
added
perform linkcheck in CI
namurphy
commented
May 2, 2024
| workflow_dispatch: | ||
|
|
||
| env: | ||
| DOC_TROUBLESHOOTING: "Warnings like 'reference target not found' occur when Sphinx tries to interpret text as a Python object, but is unable to do so. This warning can often be fixed by surrounding text in double back ticks instead of single back ticks (e.g., by changing `y` to ``y``) so that it gets formatted as an in-line literal. For more information about addressing documentation build failures, please check out the documentation troubleshooting guide at: https://docs.plasmapy.org/en/latest/contributing/doc_guide.html#troubleshooting" |
Member
Author
There was a problem hiding this comment.
📌 In a follow-up PR, I'm wondering if it would be worth including this in its own file. Alternatively, it could be included in the nox environment itself. 🤔
namurphy
commented
May 2, 2024
Comment on lines
+92
to
+93
| - name: Build documentation with Sphinx | ||
| run: nox -e docs -- -q |
Member
Author
There was a problem hiding this comment.
The -q makes the documentation build quiet, which makes it easier to find warnings and errors.
namurphy
commented
May 2, 2024
|
|
||
| All public releases of PlasmaPy are openly archived in the `PlasmaPy | ||
| Community <https://zenodo.org/communities/plasmapy>`__ on |Zenodo|. | ||
| Community <https://zenodo.org/communities/plasmapy/records>`__ on |Zenodo|. |
Member
Author
There was a problem hiding this comment.
🏕️ I updated a few redirects since I was running linkcheck anyway.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR switches some GitHub workflows from being run with tox to being run with nox, including:
Motivation
Presently, our tox configuration file is difficult to understand and maintain. Using nox lets us have a configuration file that is written in Python.
Related issues
This PR is a follow-up on #2654. See also #1734 & #1735.