-
Notifications
You must be signed in to change notification settings - Fork 30
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
Add utility script documentation to the Users Guide, moved to standard sphinx directory structure and names #514
Merged
Conversation
This file contains 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
edwardhartnett
changed the title
Add utility script documentation to the Users Guide
Add utility script documentation to the Users Guide, moved to standard sphinx directory structure and names
Oct 7, 2024
edwardhartnett
requested review from
MatthewPyle-NOAA,
ShunLiu-NOAA,
JacobCarley-NOAA and
BenjaminBlake-NOAA
as code owners
October 7, 2024 10:56
MatthewPyle-NOAA
approved these changes
Oct 7, 2024
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.
No fears on merging documentation changes - will get this one merged in case other outstanding PRs require more work to merge.
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.
DESCRIPTION OF CHANGES:
In this PR I set up sphinx/readthedocs so that the python scripts in the ush directory are included in the documentation. Not all scripts have documentation written yet - but that will come in future PRs. Also moved files into standard sphinx directory structure.
No code changes in this PR, only documentation. I had to add a lot of .rst files to the repo. Unfortunately, this is just a byproduct of sphinx. It seems to be how everyone does things, so we just have to live with them.
TESTS CONDUCTED:
N/A
Machines/Platforms:
N/A
Test cases:
N/A
ISSUE:
Part of #502