Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs generation #198

Merged
merged 2 commits into from
Nov 3, 2024
Merged

Update docs generation #198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a3e0b0b
fixed incorrect docstring
kozlov721 Nov 1, 2024
c2ec31c
updated docs action
kozlov721 Nov 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions .github/workflows/ci.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
5 changes: 3 additions & 2 deletions luxonis_ml/data/datasets/annotation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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")
Expand Down
Loading