t4-devkit/mkdocs.yaml at main · tier4/t4-devkit · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
site_name: t4-devkit
repo_url: https://github.com/tier4/t4-devkit
repo_name: tier4/t4-devkit

nav:
  - Home:
      - t4-devkit: index.md
      - Installation: install.md
  - Dataset Schema:
      - Home: schema/index.md
      - Schema Tables: schema/table.md
      - Sensor Data: schema/data.md
      - Requirements: schema/requirement.md
  - Tutorials:
      - Initialization: tutorials/initialize.md
      - Visualization: tutorials/render.md
      - Schema Customization: tutorials/customize.md
      - Sanity Check: tutorials/sanity.md
  - CLI:
      - Home: cli/index.md
      - t4viz: cli/t4viz.md
      - t4sanity: cli/t4sanity.md
  - API References:
      - t4_devkit.tier4: apis/tier4.md
      - t4_devkit.helper: apis/helper.md
      - t4_devkit.sanity: apis/sanity.md
      - t4_devkit.schema:
          - Home: apis/schema/index.md
          - Schema Names: apis/schema/name.md
          - Schema Tables: apis/schema/table.md
          - Other Items for Tables: apis/schema/other.md
          - Schema Registry: apis/schema/registry.md
          - Serialize Schema: apis/schema/serialize.md
      - t4_devkit.dataclass: apis/dataclass.md
      - t4_devkit.filtering: apis/filtering.md
      - t4_devkit.viewer: apis/viewer.md
      - t4_devkit.typing: apis/typing.md
      - t4_devkit.common: apis/common.md

theme:
  name: material
  features:
    - navigation.indexes
    - navigation.instant
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.tracking
  palette:
    scheme: default
  logo: assets/logo.png

plugins:
  - search
  - mermaid2
  - mike:
      version_selector: true
      canonical_version: latest
  - mkdocstrings:
      handlers:
        python:
          paths: ["t4_devkit"]
          inventories: # Cross-references for python and numpy
            - https://arrow.apache.org/docs/objects.inv
            - https://docs.python.org/3/objects.inv
            - https://numpy.org/doc/stable/objects.inv
            - https://ipython.readthedocs.io/en/stable/objects.inv
          options:
            extra:
              # general
              filters: ["!^_"]
              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:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid_custom

  - pymdownx.details
  - admonition

# Some extra styling
extra_css:
  - css/mkdocstrings.css

# https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/
extra:
  version:
    provider: mike
    default: latest