WIP documentation generation via gh actions (#107)

Summary: Pull Request resolved: #107 Differential Revision: D67157339
facebookresearch · Dec 12, 2024 · f2f124a · f2f124a
1 parent c9576ed
commit f2f124a
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -17,9 +17,13 @@ jobs:
         python-version: 3.9
     - name: Install dependencies
       run: |
+          pip install pdoc3
           pip install pytest
           pip install pytest-cov
           pip install -e .
+    - name: Update documentation
+      run: |
+        pdoc -o ./html pearl
     - name: Generate coverage report
       run: |
         pytest --cov=./ --cov-report=xml

diff --git a/pearl/api/action_result.py b/pearl/api/action_result.py
@@ -23,9 +23,9 @@ class ActionResult:
     reward: Reward
     terminated: bool
     truncated: bool
-    info: dict[str, Any] | None = None
-    cost: float | None = None
-    available_action_space: ActionSpace | None = None
+    info: Optional[dict[str, Any]] = None
+    cost: Optional[float] = None
+    available_action_space: Optional[ActionSpace] = None
 
     @property
     def done(self) -> bool: