add docs

uw-cryo · Nov 22, 2024 · 02ec20b · 02ec20b
1 parent e2c66c9
commit 02ec20b
Show file tree

Hide file tree

Showing 8 changed files with 2,035 additions and 1,225 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -15,6 +15,7 @@ repos:
     rev: "v4.6.0"
     hooks:
       - id: check-added-large-files
+        args: ["--maxkb=1000"]
       - id: check-case-conflict
       - id: check-merge-conflict
       - id: check-symlinks

diff --git a/docs/api.rst b/docs/api.rst
@@ -43,3 +43,16 @@ Datasets
    general.Dataset
    maxar.open_browse
    maxar.plot_browse
+
+
+IO
+--
+
+.. currentmodule:: coincident.io
+
+.. autosummary::
+   :toctree: generated/
+
+   sliderule.subset_gedi02a
+   sliderule.subset_atl06
+   sliderule.sample_3dep
diff --git a/docs/conf.py b/docs/conf.py
@@ -88,3 +88,4 @@
 always_document_param_types = True
 # autodoc_typehints = "none"
 nb_execution_mode = "auto"  # off, on
+nb_execution_excludepatterns = ["sliderule.ipynb"]
diff --git a/docs/examples/index.md b/docs/examples/index.md
@@ -8,4 +8,5 @@ This section contains Jupyter Notebooks with narrative workflows using the
 
 quickstart
 cascading_search
+sliderule
 ```
diff --git a/docs/examples/sliderule.ipynb b/docs/examples/sliderule.ipynb
diff --git a/pixi.lock b/pixi.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -63,6 +63,7 @@ docs = [
   "myst-nb",
   "myst_parser>=0.13",
   "pydata-sphinx-theme>=0.16.0,<0.17",
+  #"rpds-py>=0.21.0,<0.22",
   "sphinx>=7.0",
   "sphinx_autodoc_typehints",
   "sphinx_copybutton",
@@ -120,7 +121,7 @@ report.exclude_also = [
 ]
 
 [tool.codespell]
-skip="pixi.lock"
+skip="pixi.lock,docs/examples/sliderule.ipynb"
 
 [tool.mypy]
 files = ["src", "tests"]

diff --git a/src/coincident/io/sliderule.py b/src/coincident/io/sliderule.py
@@ -41,7 +41,7 @@ def _granule_from_assets(assets: gpd.GeoDataFrame) -> str:
     # NOTE: change to while loop in case tons of assets?
     for _k, v in assets.items():
         if v.get("roles") == "data":
-            granule = Path.name(v.get("href"))
+            granule = Path(v.get("href")).name
 
     return granule