From 7f28f957caca277be9baa650dc0f5e6d85a822f7 Mon Sep 17 00:00:00 2001
From: Wei Ji <23487320+weiji14@users.noreply.github.com>
Date: Wed, 8 Jun 2022 22:08:02 -0400
Subject: [PATCH] :art: Extra subsection for rioxarray datapipes (#18)

Reorganizing some files in anticipation of new features coming soon!

* :art: Extra subsection for rioxarray datapipes

Some more structure to the API docs in anticipation of new classes in the pipeline!

* :truck: 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.
---
 .github/workflows/ci-tests.yml                               | 2 +-
 docs/api.md                                                  | 5 +++++
 zen3geo/datapipes/rioxarray.py                               | 2 +-
 .../tests/{test_datapipes.py => test_datapipes_rioxarray.py} | 2 +-
 4 files changed, 8 insertions(+), 3 deletions(-)
 rename zen3geo/tests/{test_datapipes.py => test_datapipes_rioxarray.py} (96%)

diff --git a/.github/workflows/ci-tests.yml b/.github/workflows/ci-tests.yml
index 07ccb77..98dd459 100644
--- 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
index 0b06f1d..dc7cf0b 100644
--- 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
index dcb4813..7b471ee 100644
--- 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 b/zen3geo/tests/test_datapipes_rioxarray.py
similarity index 96%
rename from zen3geo/tests/test_datapipes.py
rename to zen3geo/tests/test_datapipes_rioxarray.py
index 59b074f..1da1f20 100644
--- a/zen3geo/tests/test_datapipes.py
+++ b/zen3geo/tests/test_datapipes_rioxarray.py
@@ -1,5 +1,5 @@
 """
-Tests for datapipes.
+Tests for rioxarray datapipes.
 """
 from torchdata.datapipes.iter import IterableWrapper