update python docs action

probably-nothing-labs · Nov 14, 2024 · ef577e7 · ef577e7
1 parent 381d56f
commit ef577e7
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 11 deletions.
diff --git a/.github/workflows/python-docs.yml b/.github/workflows/python-docs.yml
@@ -20,7 +20,7 @@ jobs:
     runs-on: ubuntu-latest
     defaults:
       run:
-        working-directory: py-denormalized
+        working-directory: ./py-denormalized
     steps:
       - uses: actions/checkout@v4
 
@@ -29,13 +29,20 @@ jobs:
         with:
           version: "0.5.1"
           enable-cache: true
-          cache-dependency-glob: "uv.lock"
+          cache-dependency-glob: "py-denormalized/uv.lock"
+
+      - name: "Set up Python"
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: "py-denormalized/pyproject.toml"
 
-      - name: Set up Python
-        run: uv python install
       - name: Install the project
-        run: uv sync --all-extras --dev
-      - run: pdoc -t pdocs/ python/denormalized/ -o pdocs/_build
+        run: uv sync --no-dev --group docs --extra feast
+
+      - name: Configure Virtual Environment
+        run: |
+          source .venv/bin/activate
+          pdoc -t pdocs/ python/denormalized/ -o pdocs/_build
 
       - uses: actions/upload-pages-artifact@v3
         with:
@@ -48,7 +55,7 @@ jobs:
     runs-on: ubuntu-latest
     defaults:
       run:
-        working-directory: py-denormalized
+        working-directory: ./py-denormalized
     permissions:
       pages: write
       id-token: write

diff --git a/py-denormalized/pyproject.toml b/py-denormalized/pyproject.toml
@@ -13,6 +13,9 @@ dependencies = [
     "datafusion>=40.1.0",
 ]
 
+[project.optional-dependencies]
+feast = ["feast"]
+
 [dependency-groups]
 dev = [
     "pdoc>=15.0.0",
@@ -25,7 +28,9 @@ dev = [
     "pdoc>=15.0.0",
     "pip>=24.3.1",
 ]
-feast = ["feast"]
+docs = [
+    "pdoc>=15.0.0",
+]
 
 [tool.maturin]
 python-source = "python"

diff --git a/py-denormalized/python/denormalized/feast_data_stream.py b/py-denormalized/python/denormalized/feast_data_stream.py
@@ -66,6 +66,8 @@ class FeastDataStream(DataStream, metaclass=FeastDataStreamMeta):
 
     This class extends DataStream to provide integration with Feast feature stores
     and related functionality.
+
+    You must install with the extra 'feast': `pip install denormalized[feast]`
     """
 
     def __init__(self, stream: Union[PyDataStream, DataStream]) -> None:

diff --git a/py-denormalized/uv.lock b/py-denormalized/uv.lock