Add to CI: Ensure docs build without warnings (#229)

* Add ci test for docs * remove middleware doc * small edits
developmentseed · Feb 6, 2025 · 5a84390 · 5a84390
1 parent 645a301
commit 5a84390
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 5 deletions.
diff --git a/.github/workflows/test-python.yml b/.github/workflows/test-python.yml
@@ -66,3 +66,8 @@ jobs:
       - name: Run python tests
         run: |
           uv run pytest tests
+
+      # Ensure docs build without warnings
+      - name: Check docs
+        if: "${{ matrix.python-version == 3.11 }}"
+        run: uv run mkdocs build --strict
diff --git a/docs/api/store/middleware.md b/docs/api/store/middleware.md
diff --git a/obstore/python/obstore/fsspec.py b/obstore/python/obstore/fsspec.py
@@ -46,7 +46,7 @@ def __init__(
         store: obs.store.ObjectStore,
         *args,
         asynchronous: bool = False,
-        loop=None,
+        loop: Any = None,
         batch_size: int | None = None,
     ):
         """Construct a new AsyncFsspecStore
@@ -192,7 +192,7 @@ def read(self, length: int = -1):
 
         Args:
             length: if positive, returns up to this many bytes; if negative, return all
-            remaining byets.
+                remaining byets.
         """
         if length < 0:
             data = self.fs.cat_file(self.path, self.loc, self.size)