diff --git a/docs/apis/schema/other.md b/docs/apis/schema/other.md index e2b5135..c608421 100644 --- a/docs/apis/schema/other.md +++ b/docs/apis/schema/other.md @@ -8,11 +8,12 @@ Following classes are sub items composed of each schema tables. ::: t4_devkit.schema.tables options: - members: ["FileFormat", "SensorModality", "VisibilityLevel", "RLEMask", "ShiftState", "IndicatorState", "Indicators", "AdditionalInfo"] + members: ["FileFormat", "SensorModality", "VisibilityLevel", "RLEMask", "ShiftState", "IndicatorState", "Indicators", "AdditionalInfo", "AutolabelModel", "AutolabelMixin"] show_root_toc_entry: false merge_init_into_class: false show_signature_annotations: false show_docstring_attributes: true + show_root_heading: false ## `Sensor` @@ -25,6 +26,7 @@ Following classes are sub items composed of each schema tables. merge_init_into_class: false show_signature_annotations: false show_docstring_attributes: true + show_root_heading: false ## `ObjectAnn`/`SurfaceAnn` @@ -37,6 +39,7 @@ Following classes are sub items composed of each schema tables. merge_init_into_class: false show_signature_annotations: false show_docstring_attributes: true + show_root_heading: false ## `Visibility` @@ -49,6 +52,7 @@ Following classes are sub items composed of each schema tables. merge_init_into_class: false show_signature_annotations: false show_docstring_attributes: true + show_root_heading: false ## `VehicleState` @@ -61,5 +65,6 @@ Following classes are sub items composed of each schema tables. merge_init_into_class: false show_signature_annotations: false show_docstring_attributes: true + show_root_heading: false diff --git a/docs/apis/schema/table.md b/docs/apis/schema/table.md index 8189f99..d2179fa 100644 --- a/docs/apis/schema/table.md +++ b/docs/apis/schema/table.md @@ -2,7 +2,7 @@ ::: t4_devkit.schema.tables options: - filters: ["!SchemaBase", "!FileFormat", "!SensorModality", "!VisibilityLevel", "!RLEMask", "!ShiftState", "!IndicatorState", "!Indicators", "!AdditionalInfo"] + filters: ["!SchemaBase", "!FileFormat", "!SensorModality", "!VisibilityLevel", "!RLEMask", "!ShiftState", "!IndicatorState", "!Indicators", "!AdditionalInfo", "!AutolabelModel", "!AutolabelMixin"] show_root_toc_entry: false merge_init_into_class: false show_signature_annotations: false diff --git a/mkdocs.yaml b/mkdocs.yaml index d0c39ae..96cd127 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -64,21 +64,27 @@ plugins: - https://numpy.org/doc/stable/objects.inv - https://ipython.readthedocs.io/en/stable/objects.inv options: - docstring_style: google - docstring_section_style: list # list spacy table - heading_level: 3 + # general filters: ["!^_"] - show_bases: true - show_source: false - inherited_members: false - members_order: source # The order of class members - parameter_headings: true - show_root_heading: false + show_bases: false + show_source: true + # headings + heading_level: 2 + parameter_headings: false + show_root_heading: true show_symbol_type_heading: true show_symbol_type_toc: true + # members + inherited_members: false + members_order: source # The order of class members + # docstrings + docstring_style: google + docstring_section_style: list # list spacy table merge_init_into_class: true + # signatures separate_signature: true show_signature_annotations: true + show_overload: true markdown_extensions: - pymdownx.highlight: