Update documentation, add CI/Docs GitHub Actions, and resolve type/lint errors - #4
Merged
Conversation
…dexing, setters, and compression
…ion compatibility
… update CI matrix for 3.12/3.13
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
This PR updates the project documentation to accurately reflect internal capabilities, fixes type check and linter errors, and adds GitHub Actions for continuous integration and documentation deployment.
Key Changes
vcsc.load_and_normalize(fused loader and depth-normalization kernel for IVCSR files).VCSCAnnData.raw_Xproperty and its distinction from standard AnnData.raw.x @ v,v @ B,B @ v), major-axis fast slicing (v[:, [1, 3, 5]]), array conversion utilities (to_csc,to_csr,toarray,from_scipy), andto_layer.write_zarr/read_zarr) and standard installation instructions.load_and_normalizeto Sphinx API reference (docs/api.md) and usage guide (docs/usage.md).ty checkandruff checkdiagnostics insrc/vcsc/_rapid_load.py,src/vcsc/_ivcsc.py,src/vcsc/_compression.py, andtests/test_rapid_load.py..github/workflows/ci.yml: Runsruff check .,ty check, andpytest --covacross Python matrix (3.11, 3.12)..github/workflows/docs.yml: Builds Sphinx HTML documentation on PRs and deploys to GitHub Pages on merges tomain.*.h5ad,*.zarr, and*.h5to.gitignoreto prevent accidental check-in of large dataset archives.