🎨 Extra subsection for rioxarray datapipes (#18)

Reorganizing some files in anticipation of new features coming soon! * 🎨 Extra subsection for rioxarray datapipes Some more structure to the API docs in anticipation of new classes in the pipeline! * 🚚 Rename test_datapipes.py to test_datapipes_rioxarray.py Making individual test files specific to the library being imported. Also moved the --verbose flag in ci-test.yml to be behind pytest.
weiji14 · Jun 9, 2022 · 7f28f95 · 7f28f95
1 parent 4d1fa95
commit 7f28f95
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 3 deletions.
diff --git a/.github/workflows/ci-tests.yml b/.github/workflows/ci-tests.yml
@@ -43,4 +43,4 @@ jobs:
 
       # Run the unit tests and doctests
       - name: Test with pytest
-        run: poetry run --verbose pytest --doctest-modules zen3geo/
+        run: poetry run pytest --verbose --doctest-modules zen3geo/
diff --git a/docs/api.md b/docs/api.md
@@ -5,7 +5,12 @@
 ```{eval-rst}
 .. automodule:: zen3geo.datapipes
     :members:
+```
+
+### Rioxarray
 
+```{eval-rst}
+.. automodule:: zen3geo.datapipes.rioxarray
 .. autoclass:: zen3geo.datapipes.RioXarrayReader
 .. autoclass:: zen3geo.datapipes.rioxarray.RioXarrayReaderIterDataPipe
     :show-inheritance:

diff --git a/zen3geo/datapipes/rioxarray.py b/zen3geo/datapipes/rioxarray.py
@@ -1,5 +1,5 @@
 """
-DataPipes for rioxarray.
+DataPipes for :doc:`rioxarray <rioxarray:index>`.
 """
 from typing import Any, Dict, Iterator, Optional, Tuple
 

diff --git a/zen3geo/tests/test_datapipes.py → zen3geo/tests/test_datapipes_rioxarray.py b/zen3geo/tests/test_datapipes.py → zen3geo/tests/test_datapipes_rioxarray.py
@@ -1,5 +1,5 @@
 """
-Tests for datapipes.
+Tests for rioxarray datapipes.
 """
 from torchdata.datapipes.iter import IterableWrapper