moteus/mkdocs.yml at main · mjbots/moteus · 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
141
142
143
site_name: moteus Documentation
site_url: https://mjbots.github.io/moteus/
repo_url: https://github.com/mjbots/moteus
repo_name: mjbots/moteus
edit_uri: edit/main/docs/

extra_css:
  - style.css
  - stylesheets/iv-viewer.min.css

extra_javascript:
  - javascripts/iv-viewer.min.js
  - javascripts/image-zoom.js
  - javascripts/toc-collapse.js

theme:
  name: material
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.indexes
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - def_list
  - tables
  - toc:
      permalink: true

plugins:
  - search
  - macros:
      module_name: docs/main
  - mkdocstrings:
      handlers:
        python:
          paths: [lib/python]
          options:
            docstring_style: google
            show_source: false
            heading_level: 3
            show_root_heading: false
            show_root_toc_entry: false
            members_order: source
            group_by_category: true

nav:
  - Introduction:
      - Overview: index.md
      - Quick Start: quick-start.md

  - Using moteus:
      - guides/index.md
      - Mechanical Setup: guides/mechanical-setup.md
      - Electrical Setup: guides/electrical-setup.md
      - Software Installation: guides/software-installation.md
      - Configuration: guides/configuration.md
      - Encoder Overview: guides/encoder-overview.md
      - Calibration: guides/calibration.md
      - PID Tuning: guides/pid-tuning.md
      - Control Modes: guides/control-modes.md
      - Advanced Configuration:
          - Motor with Hall Effects: guides/hall-effects.md
          - Dual Encoders: guides/dual-encoders.md
          - Optimizing for Maximum Duty Cycle: guides/optimizing-for-max-duty-cycle.md
          - Field Weakening: guides/field-weakening.md

  - Integration:
      - integration/index.md
      - Python Client: integration/python.md
      - C++ Client: integration/cpp.md
      - Rust Client: integration/rust.md
      - Raw CAN-FD: integration/can-fd.md
      - UART: integration/uart.md
      - Host Platforms:
          - platforms/index.md
          - Raspberry Pi: platforms/raspberry-pi.md
          - Nvidia Jetson: platforms/jetson.md
          - socketcan: platforms/socketcan.md
          - Arduino: platforms/arduino.md

  - Troubleshooting:
      - troubleshooting/index.md
      - Calibration: troubleshooting/calibration.md
      - No Motion: troubleshooting/no-motion.md
      - Limited Torque: troubleshooting/limited-torque.md
      - Gate Driver Faults: troubleshooting/gate-driver-faults.md
      - Timeout Mode 11: troubleshooting/timeout-mode-11.md
      - Overvoltage Fault 34: troubleshooting/overvoltage-fault-34.md

  - Reference:
      - reference/index.md
      - Pinouts: reference/pinouts.md
      - Encoders: reference/encoders.md
      - Client Tools: reference/client-tools.md
      - Configuration Parameters: reference/configuration.md
      - Hardware Specifications: reference/hardware.md
      - Flashing and Building Firmware: reference/firmware.md
      - Application Limits: reference/limits.md
      - Theory of Operation: reference/theory.md
      - API Reference:
          - Python: reference/python.md
          - Rust: reference/rust.md
      - Protocol:
          - protocol/index.md
          - CAN Protocol: protocol/can.md
          - Register Reference: protocol/registers.md
          - Diagnostic Protocol: protocol/diagnostic.md