sync_tooling/mkdocs.yml at main · tier4/sync_tooling · 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
116
117
118
119
120
site_name: SYNC.TOOLING
repo_url: https://github.com/tier4/sync_tooling
theme:
  name: material
  features:
    - content.code.annotate
    - content.tabs.link
  palette:
    - scheme: default
      primary: white
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - scheme: slate
      primary: grey
      toggle:
        icon: material/weather-night
        name: Switch to light mode
nav:
  - Home: index.md
  - Design: design.md
  - Installation: installation.md
  - Usage: usage.md
  - PTP Architecture Guide: ptp-architecture-guide.md
  - Integrators' Guide: integrators-guide.md
  - For Developers:
      - Sensor Driver Integration: sensor-driver-integration.md
markdown_extensions:
  - attr_list
  - md_in_html
  - footnotes
  - admonition
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.snippets:
      check_paths: true
      dedent_subsections: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

plugins:
  - search
  - macros:
      module_name: scripts/mkdocs_macros
  - drawio
  - autorefs
  - api-autonav:
      modules:
        - sync_tooling_msgs/src/sync_tooling_msgs
        - diag_master/src/diag_master
        - diag_worker/src/diag_worker
        - sync_graph/src/sync_graph
        - pmc_monitor/src/pmc_monitor
        - linuxptp_monitor/src/linuxptp_monitor
        - journal_monitor/src/journal_monitor
        - ros2_transport/src/ros2_transport
      nav_section_title: "API Reference"
      api_root_uri: "reference"
      nav_item_prefix: "<code class='doc-symbol doc-symbol-nav doc-symbol-module'></code>"
      exclude_private: true
  - section-index
  - mkdocstrings:
      handlers:
        python:
          inventories:
            - url: https://docs.python.org/3/objects.inv
              domains: [std, py]
            - https://typing-extensions.readthedocs.io/en/latest/objects.inv
          options:
            backlinks: tree
            docstring_options:
              ignore_init_summary: true
            docstring_style: google
            docstring_section_style: list
            heading_level: 2
            inherited_members: true
            merge_init_into_class: true
            parameter_headings: false
            separate_signature: true
            show_bases: true
            show_inheritance_diagram: false
            show_root_heading: true
            show_root_full_path: false
            show_source: false
            show_signature_annotations: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            show_if_no_docstring: false
            signature_crossrefs: true
            summary: true
extra_javascript:
  - js/dark-mode-support.js
extra_css:
  - css/mermaid-tweaks.css

watch:
  - sync_tooling_msgs/src
  - diag_master/src
  - diag_worker/src
  - sync_graph/src
  - pmc_monitor/src
  - linuxptp_monitor/src
  - journal_monitor/src
  - ros2_transport/src
  - README.md
  - docs
  - mkdocs.yml