Repository navigation
docs: refresh README and Read the Docs pages - #76
Merged
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
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
The README and the Read the Docs pages were last refreshed in April 2026. This PR brings them up to date with the code. It changes docs only; there are no code or test changes.
.[full,dev]), the docs link and the NOAA disclaimer.nos_utils.forcingmodules, a newpost.rstfornos_utils.post, andcoords.rst.:no-members:, to stop duplicate entries.PrepOrchestrator(..., skip_legacy=False)runs the SECOFS RTOFS and NWM steps. Thenos-utils prepCLI keeps the default, which skips them.$FIXofs/$FIXstofs3d, exact file names) is described correctly.NWMProcessor(analysis_assim).build_npzreplaces the namebuild_ssh_npz, which does not exist.numpyis removed fromautodoc_mock_imports. It is a core dependency, and mocking it broke the import ofnudge_opson Read the Docs.This PR does not touch the clone-URL lines that #75 edits; a test merge with #75 is clean.
Type of change
Change characteristics
How has this been tested?
pip install .[docs]only): 0 autodoc import failures. The 7 remaining warnings are existing docstring formatting..[full,docs], as the GitHub Docs workflow installs.Checklist