Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1643 +/- ##
==========================================
+ Coverage 94.61% 95.41% +0.79%
==========================================
Files 107 107
Lines 9664 9664
Branches 1464 1464
==========================================
+ Hits 9144 9221 +77
+ Misses 327 257 -70
+ Partials 193 186 -7 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
namurphy
added
status: dormant
# Conflicts: # docs/_static/css/plasmapy.css # docs/conf.py # docs/plasmapy_sphinx/autodoc/automodapi.py # docs/plasmapy_sphinx/automodsumm/core.py # docs/plasmapy_sphinx/automodsumm/generate.py # docs/plasmapy_sphinx/directives/event.py # docs/plasmapy_sphinx/utils.py # requirements/docs.txt # setup.cfg
rocco8773
commented
May 8, 2025
| # This is processed by Jinja2 and inserted before each notebook | ||
| nbsphinx_prolog = r""" | ||
| {% set docname = 'docs/' + env.doc2path(env.docname, base=None) %} | ||
| {% set docname = 'docs/' + env.doc2path(env.docname, base=None) | string %} |
Member
Author
There was a problem hiding this comment.
For sphinx>=8.0 BuildEnvironment.doc2path() started returning a _StrPath object, which resulted in the following exception...
To fix this I added | string to the docname declaration in nbsphinx_prolog. This converts the composed docname into a string.
namurphy
reviewed
May 8, 2025
namurphy
reviewed
May 8, 2025
pyproject.toml
Outdated
| "plasmapy-sphinx>=0.2.0b1", | ||
| "pygments==2.18", | ||
| "sphinx==7.3.7", | ||
| "sphinx", |
Member
There was a problem hiding this comment.
Suggested change
| "sphinx", | |
| "sphinx>=8.2.3", |
namurphy
reviewed
May 8, 2025
namurphy
reviewed
May 8, 2025
Comment on lines
+1
to
+5
| /* | ||
| * Any overrides defined here should make their way to the plasmapy.css | ||
| * in plasmapy_sphinx (i.e. plasmapy_sphinx/theme/static/css/plasmapy.css) | ||
| * | ||
| */ |
namurphy
approved these changes
May 8, 2025
Member
namurphy
left a comment
namurphy
left a comment
There was a problem hiding this comment.
LGTM! 🚀 Thank you for doing this! 🙏🏻
Co-authored-by: Nick Murphy <[email protected]>
namurphy
reviewed
May 8, 2025
changelog/1643.doc.3.rst
Outdated
| @@ -0,0 +1,2 @@ | |||
| Removed upper dependency limit on `sphinx`, and added lower limit of | |||
| `>=8.2.3`. | |||
Member
There was a problem hiding this comment.
Suggested change
| `>=8.2.3`. | |
| ``>=8.2.3``. |
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
3 participants
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 updates
plasmapyin accordance with movingplasmapy_sphinxinto its own repository,plasmapy_sphinx.Items that changed...
docs/plasmapy_sphinxand put it into its own repoplasmapy_sphinx.docs/api_staticrelated toplasmapy_sphinx.docs/_templatesand CSS filesdocs/_static/cssand integrated them intoplasmapy_sphinx.docs/_static/css/overrides.cssstylesheet so style changes can be made quickly, allowing time for them to integrated intoplasmapy_sphinx.plasmapy_sphinxas adocsdependency.docs/conf.pyto used theplasmapy_theme, which is available with theplasmapy_sphinx.themeextension.plasmapy_sphinx.ext.autodocandplasmapy_sphinx.ext.directives.plasmapy_sphinxto theintersphinx_mapping.sphinx, and repaired build warnings that resulted.("py:class", "dimensionsless")tonitpicky_ignore_regex. Astropy does not produceintersphinxlinks fordimensionless_unscaled, which caused build warning since we use this as a type annotation.nbsphinx_prologjinja2template so variabledocnameis always converted to a string. This was a problem insphinx>=8.0, sinceBuildEnvironment.doc2path()started returning a_StrPathobject instead of a string.weekly.ymlandnoxfile.pyto included a weekly build test on the dev/latest version ofplasmapy_sphinx.requirements/*and.venvsto.gitignore.Note
The requirements currently have
plasmapy_sphinxbeing pulled directly from the GitHub repo, since it has not been released to PyPI yet. We can consider making the switch to PyPI onceplasmapy_sphinxis released. However, my current thought is to stick with pulling from GitHub since we can then get immediate updates.