Skip to content

Commit d144614

Browse files
authored
docs: update API references (#231)
Signed-off-by: ktro2828 <kotaro.uetake@tier4.jp>
1 parent d01de28 commit d144614

3 files changed

Lines changed: 22 additions & 11 deletions

File tree

docs/apis/schema/other.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,12 @@ Following classes are sub items composed of each schema tables.
88

99
::: t4_devkit.schema.tables
1010
options:
11-
members: ["FileFormat", "SensorModality", "VisibilityLevel", "RLEMask", "ShiftState", "IndicatorState", "Indicators", "AdditionalInfo"]
11+
members: ["FileFormat", "SensorModality", "VisibilityLevel", "RLEMask", "ShiftState", "IndicatorState", "Indicators", "AdditionalInfo", "AutolabelModel", "AutolabelMixin"]
1212
show_root_toc_entry: false
1313
merge_init_into_class: false
1414
show_signature_annotations: false
1515
show_docstring_attributes: true
16+
show_root_heading: false
1617

1718
## `Sensor`
1819

@@ -25,6 +26,7 @@ Following classes are sub items composed of each schema tables.
2526
merge_init_into_class: false
2627
show_signature_annotations: false
2728
show_docstring_attributes: true
29+
show_root_heading: false
2830

2931
## `ObjectAnn`/`SurfaceAnn`
3032

@@ -37,6 +39,7 @@ Following classes are sub items composed of each schema tables.
3739
merge_init_into_class: false
3840
show_signature_annotations: false
3941
show_docstring_attributes: true
42+
show_root_heading: false
4043

4144
## `Visibility`
4245

@@ -49,6 +52,7 @@ Following classes are sub items composed of each schema tables.
4952
merge_init_into_class: false
5053
show_signature_annotations: false
5154
show_docstring_attributes: true
55+
show_root_heading: false
5256

5357
## `VehicleState`
5458

@@ -61,5 +65,6 @@ Following classes are sub items composed of each schema tables.
6165
merge_init_into_class: false
6266
show_signature_annotations: false
6367
show_docstring_attributes: true
68+
show_root_heading: false
6469

6570
<!-- prettier-ignore-end -->

docs/apis/schema/table.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
::: t4_devkit.schema.tables
44
options:
5-
filters: ["!SchemaBase", "!FileFormat", "!SensorModality", "!VisibilityLevel", "!RLEMask", "!ShiftState", "!IndicatorState", "!Indicators", "!AdditionalInfo"]
5+
filters: ["!SchemaBase", "!FileFormat", "!SensorModality", "!VisibilityLevel", "!RLEMask", "!ShiftState", "!IndicatorState", "!Indicators", "!AdditionalInfo", "!AutolabelModel", "!AutolabelMixin"]
66
show_root_toc_entry: false
77
merge_init_into_class: false
88
show_signature_annotations: false

mkdocs.yaml

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -64,21 +64,27 @@ plugins:
6464
- https://numpy.org/doc/stable/objects.inv
6565
- https://ipython.readthedocs.io/en/stable/objects.inv
6666
options:
67-
docstring_style: google
68-
docstring_section_style: list # list spacy table
69-
heading_level: 3
67+
# general
7068
filters: ["!^_"]
71-
show_bases: true
72-
show_source: false
73-
inherited_members: false
74-
members_order: source # The order of class members
75-
parameter_headings: true
76-
show_root_heading: false
69+
show_bases: false
70+
show_source: true
71+
# headings
72+
heading_level: 2
73+
parameter_headings: false
74+
show_root_heading: true
7775
show_symbol_type_heading: true
7876
show_symbol_type_toc: true
77+
# members
78+
inherited_members: false
79+
members_order: source # The order of class members
80+
# docstrings
81+
docstring_style: google
82+
docstring_section_style: list # list spacy table
7983
merge_init_into_class: true
84+
# signatures
8085
separate_signature: true
8186
show_signature_annotations: true
87+
show_overload: true
8288

8389
markdown_extensions:
8490
- pymdownx.highlight:

0 commit comments

Comments
 (0)