Skip to content

Add documentation site#7

Merged
taddyb merged 6 commits intomasterfrom
docs
Apr 6, 2026
Merged

Add documentation site#7
taddyb merged 6 commits intomasterfrom
docs

Conversation

@taddyb
Copy link
Copy Markdown
Contributor

@taddyb taddyb commented Apr 6, 2026

Summary

  • Add zensical-powered documentation site with four pages: landing, getting started, benchmarks, and API reference
  • Add docs optional dependency group (zensical, mkdocstrings[python]) to pyproject.toml
  • Add GitHub Actions workflow for deploying to GitHub Pages on push to master
  • Hand-written API docs for PyO3-exported Rust functions since mkdocstrings cannot introspect .so modules

Pages

  • index.md — Install, quick example, coverage methods, supported statistics, requirements
  • getting-started.md — Data loading, computing stats, coverage methods, nodata handling, memory, CRS, saving
  • benchmarks.md — CONUS-scale timing (225K basins), accuracy validation, environment
  • api-reference.md — xarray accessors (mkdocstrings), low-level API (hand-written signatures), statistics table

Test plan

  • cd extractrs && uv sync --extra docs && zensical serve renders all 4 pages
  • mkdocstrings renders Dataset/DataArray accessor docstrings
  • All internal links resolve
  • Light/dark mode toggle works
  • zensical build --clean produces site/ with no errors

🤖 Generated with Claude Code

taddyb added 6 commits April 5, 2026 21:19
- Add zensical.toml config with orange/black theme, GitHub Pages deployment
- Add docs/ with four pages: index, getting-started, benchmarks, API reference
- Add docs and mkdocstrings[python] optional dependencies to pyproject.toml
- Hand-written API docs for PyO3-exported Rust functions (mkdocstrings
  cannot introspect .so modules), mkdocstrings for Python accessors
Builds docs with zensical and deploys to GitHub Pages on push to master.
@taddyb taddyb merged commit 2cc2892 into master Apr 6, 2026
2 checks passed
@taddyb taddyb deleted the docs branch April 6, 2026 01:28
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.

1 participant