Skip to content
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
merged 24 commits into from
Oct 7, 2024

Conversation

edwardhartnett
Copy link
Contributor

@edwardhartnett edwardhartnett commented Oct 7, 2024

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

@edwardhartnett 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 edwardhartnett marked this pull request as ready for review October 7, 2024 10:56
Copy link
Contributor

@MatthewPyle-NOAA MatthewPyle-NOAA left a 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.

@MatthewPyle-NOAA MatthewPyle-NOAA merged commit 60707e5 into NOAA-EMC:main Oct 7, 2024
2 checks passed
@edwardhartnett edwardhartnett deleted the ejh_api_doc branch October 7, 2024 14:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants