python-damiao-driver/mkdocs.yml at main · Joeclinton1/python-damiao-driver · 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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
site_name: DaMiao Motor
site_description: Python driver for DaMiao motors over CAN
site_author: jia-xie
site_url: https://jia-xie.github.io/python-damiao-driver

repo_name: python-damiao-driver
repo_url: https://github.com/jia-xie/python-damiao-driver
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    - scheme: default
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.indexes
    - navigation.tracking
    - navigation.tabs
    - toc.integrate
    - search.suggest
    - search.highlight
    - search.share
    - shortcuts
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - content.tooltips
    - content.action.edit
    - content.action.view
    - tags
  icon:
    repo: fontawesome/brands/github
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/jia-xie/python-damiao-driver
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/damiao-motor/

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
      use_pygments: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.arithmatex:
      generic: true
  - attr_list
  - md_in_html
  - toc:
      permalink: true

plugins:
  - search:
      lang: en
  # Git revision dates - install with: pip install mkdocs-git-revision-date-localized-plugin
  # Uncomment below to enable:
  # - git-revision-date-localized:
  #     enable_creation_date: true
  #     type: date
  #     fallback_to_build_date: false
  - mkdocstrings:
      handlers:
        python:
          paths: [damiao_motor]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_toc_entry: true
            show_signature_annotations: true
            separate_signature: true
            show_submodules: true
            group_by_category: true
            filters: ["!^_"]
            members_order: alphabetical
            merge_init_into_class: true

nav:
  - Home: index.md
  - Concept:
      - Registers: concept/registers.md
      - Motor Control Modes: concept/motor-control-modes.md
      - Communication Protocol: concept/communication-protocol.md
      - CAN Bus Fundamentals: concept/can.md
  - Hardware Setup:
      - Motor Connection: hardware-setup/motor-connection.md
      - CAN Setup: hardware-setup/can-set-up.md
  - Package Tools:
      - Web GUI: package-usage/web-gui.md
      - CLI Tool: package-usage/cli-tool.md
      - Python API: package-usage/python-api.md
  - API Reference:
      - DaMiaoController: api/controller.md
      - DaMiaoMotor: api/motor.md


extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/jia-xie/python-damiao-driver
      name: GitHub
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/damiao-motor/
      name: PyPI
  version:
    provider: mike

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
  - javascripts/copyright-year.js

extra_css:
  - assets/extra.css

copyright: "Copyright &copy; <span id=\"copyright-year-range\">2025-Present</span> jia-xie"