Update docs generation (#198)

luxonis · Nov 3, 2024 · d29a7d9 · d29a7d9
1 parent e7121ff
commit d29a7d9
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 7 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -37,13 +37,10 @@ jobs:
           ref: ${{ github.head_ref }}
 
       - name: Install dependencies
-        run: |
-          pip install pydoctor
-          curl -L "https://raw.githubusercontent.com/luxonis/python-api-analyzer-to-json/main/gen-docs.py" -o "gen-docs.py"
+        run: pip install pydoctor
 
       - name: Build docs
-        run: |
-          python gen-docs.py luxonis_ml
+        run: pydoctor --docformat=epytext luxonis_ml
 
   tests:
     needs:

diff --git a/luxonis_ml/data/datasets/annotation.py b/luxonis_ml/data/datasets/annotation.py
@@ -303,8 +303,7 @@ def combine_to_numpy(
 
 
 class RLESegmentationAnnotation(SegmentationAnnotation):
-    """U{Run-length encoded<https://en.wikipedia.org/wiki/Run-length_encoding>}
-        segmentation mask.
+    """Run-length encoded segmentation mask.
 
     @type height: int
     @ivar height: The height of the segmentation mask.
@@ -315,6 +314,8 @@ class RLESegmentationAnnotation(SegmentationAnnotation):
     @type counts: Union[List[int], bytes]
     @ivar counts: The run-length encoded mask.
         This can be a list of integers or a byte string.
+
+    @see: U{Run-length encoding<https://en.wikipedia.org/wiki/Run-length_encoding>}
     """
 
     type_: Literal["rle"] = Field("rle", alias="type")