docs: update the documentation and pin the CI actions - #191
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
Hapi.*package and called the old camelCase methods, so nothing in the docs could be copied and run.
meteo-inputsremote-sensing sections, which documentedhapi.remotesensing— a module that nolonger exists — with a pointer to earth2observe, the package that
now provides the CHIRPS and ECMWF downloads.
Installation.md, which claimed Python 2.7+, anenvironment.ymlthat no longer exists, andpython setup.py install, around the real install paths and a pixi development section.mkdocs build --strictpass. The 75 griffe warnings had three separate causes:Returns:continuationlines indented at the item level (so each wrapped line was parsed as an extra untyped return), griffe's
returns_named_valuedefault readingnumpy.ndarray: descriptionas a name rather than a type, and aboutfourteen genuinely missing annotations.
docs/api/distrrm.mdanddocs/javascripts/mathjax.jsare required by
mkdocs.ymlbut had never been committed, andcheck_inputs.PNGwas tracked with anuppercase extension that only resolves on a case-insensitive filesystem.
clone counter) or that pointed at an unrelated project, repoints the rest at
serapeum-org, and fixes thefour image paths, which were root-absolute and therefore broken on GitHub.
several majors behind.
pyproject.toml, keeping only the ones that state somethingnon-obvious.
Issues
Type of change
Check relevant points.
How Has This Been Tested?
Built the documentation from the branch worktree, i.e. a clean checkout rather than a developer tree with
untracked files present:
pixi run -e docs mkdocs build --strictcompletes with no warnings.Ran
pixi run -e dev mypy, which reports no issues across 22 source files, confirming the added annotationsdid not widen the existing suppression list.
Cross-checked every image link in
docs/againstgit ls-files, and fetched every badge URL in the README toconfirm it renders rather than returning an error state.
Resolved every pinned action SHA against its upstream repository.
Test A:
pixi run -e docs mkdocs build --strict→ cleanTest B:
pixi run -e dev mypy→ no issues in 22 source filesChecklist: