Fill out some basic documentation #17
Merged
Conversation
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
namurphy
reviewed
Apr 28, 2025
plasmapy_sphinx/__init__.py
Outdated
| if sys.version_info < (3, 8): # coverage: ignore | ||
| raise ImportError("plasmapy_sphinx does not support Python < 3.8") | ||
|
|
||
| if sys.version_info >= (3, 8): |
Member
There was a problem hiding this comment.
Since the minimum version was just changed to 3.8, we should be able to remove this if/else block and drop the importlib_metadata line.
… generate_autosummary_content(), who's signature changes for sphinx >= 8.0
rocco8773
changed the title
rocco8773
changed the title
# Conflicts: # .github/workflows/check_install.yml # .github/workflows/documentation.yml
rocco8773
changed the title
rocco8773
changed the title
namurphy
reviewed
May 8, 2025
namurphy
reviewed
May 8, 2025
Co-authored-by: Nick Murphy <namurphy@users.noreply.github.com>
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! 🙏🏻
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 add some basic documentation...
plasmapy.ext.autodoc,plasmapy.ext.automodsumm,plasmapy.ext.css,plasmapy.ext.directive, andplasmapy.themehas meaningful content.Note
This PR was originally opened to do what PR #18 is did. Unfortunately this PR scope creeped into being updates to both the documentation and GitHub Workflows. The GitHub Workflow changes have now been broken out into PR #18, and this PR will just contain the documentation update.