From a3e0b0b9035fc392b7cff18be19e10497262ef9a Mon Sep 17 00:00:00 2001 From: Martin Kozlovsky Date: Fri, 1 Nov 2024 16:39:51 +0100 Subject: [PATCH 1/2] fixed incorrect docstring --- luxonis_ml/data/datasets/annotation.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/luxonis_ml/data/datasets/annotation.py b/luxonis_ml/data/datasets/annotation.py index 6862c474..9a11bc76 100644 --- 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} - 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} """ type_: Literal["rle"] = Field("rle", alias="type") From c2ec31ce51271805fb44629488322f395c5d99ca Mon Sep 17 00:00:00 2001 From: Martin Kozlovsky Date: Fri, 1 Nov 2024 16:41:59 +0100 Subject: [PATCH 2/2] updated docs action --- .github/workflows/ci.yaml | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 6d6e02ce..397f3083 100644 --- 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: