opensourceleg/mkdocs.yml at main · bargonz/opensourceleg · 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
144
145
site_name: opensourceleg
repo_url: https://github.com/neurobionics/opensourceleg
site_url: https://neurobionics.github.io/opensourceleg
site_description: An open-source SDK for developing and testing algorithms on commonly used robotic hardware.
site_author: Open-Source Leg
edit_uri: edit/main/docs/
repo_name: neurobionics/opensourceleg
copyright: Maintained by <a href="https://www.opensourceleg.org/">The Open-Source Leg Team</a>.

nav:
  - Overview: index.md
  - Installation: installation.md
  - Tutorials:
      - Sensors:
          - Getting Started: tutorials/sensors/getting_started.md
          - Reading ADC Data: tutorials/sensors/reading_adc.md
          - Reading Encoder Data: tutorials/sensors/reading_encoder_data.md
          - Reading IMU Data: tutorials/sensors/reading_imu_data.md
          - Reading Loadcell Data: tutorials/sensors/reading_loadcell_data.md
      - Actuators:
          - Getting Started: tutorials/actuators/getting_started.md
          - Reading Sensor Data: tutorials/actuators/reading_sensor_data.md
          - Commanding Voltage: tutorials/actuators/commanding_voltage.md
          - Commanding Current: tutorials/actuators/commanding_current.md
          - Commanding Position: tutorials/actuators/commanding_position.md
          - Commanding Impedance: tutorials/actuators/commanding_impedance.md
      - Control:
          - Compiled Controller: tutorials/control/compiled_controller.md
          - State Machine: tutorials/control/state_machine.md
          - Torque Trajectory: tutorials/control/torque_trajectory.md
      - Logging:
          - Getting Started: tutorials/logging/getting_started.md
          - Configuring Logger: tutorials/logging/configuring_logger.md
          - Logging Data: tutorials/logging/logging_data.md
      - Robots:
          - Getting Started: tutorials/robots/getting_started.md
          - Homing OSL Joints: tutorials/robots/homing_joints.md
      - Utilities:
          - SoftRealtimeLoop:
              - Getting Started: tutorials/utilities/softrealtimeloop/getting_started.md
              - Running Functions: tutorials/utilities/softrealtimeloop/running_functions.md
              - Using Iterators: tutorials/utilities/softrealtimeloop/using_iterators.md
              - Real-time Control: tutorials/utilities/softrealtimeloop/realtime_control.md
          - Profiler: tutorials/utilities/profiler/profiling_code.md
      - Other Best Practices: tutorials/other_best_practices.md
  - Examples:
      - Basic Motion: examples/basic_motion.md
      - Finite State Machine Walking Controller: examples/fsm_walking_controller.md
      - FSM Walking Ankle Controller: examples/fsm_walking_ankle_controller.md
  - API:
      - Actuators:
          - Base: api/actuators/actuators.md
          - Dephy: api/actuators/dephy.md
          - Moteus: api/actuators/moteus.md
          - TMotor: api/actuators/tmotor.md
      - Extras:
          - Collections:
              - Validators: api/extras/collections/validators.md
          - Safety:
              - Safety: api/extras/safety/safety.md
      - Control:
          - Compiled Controller: api/control/compiled.md
          - State Machine: api/control/fsm.md
      - Logging:
          - Logger: api/logging.md
      - Math:
          - Math: api/math/math.md
      - Sensors:
          - Base: api/sensors/sensors_base.md
          - IMU: api/sensors/imu.md
          - Loadcell: api/sensors/loadcell.md
          - ADC: api/sensors/adc.md
          - Encoder: api/sensors/encoder.md
      - Robots:
          - Base: api/robots/robots.md
          - OSL: api/robots/osl.md
      - Utilities:
          - SoftRealtimeLoop: api/utilities/softrealtimeloop.md
          - Profiler: api/utilities/profile.md
  - Contributing: contributing.md
  - Security: security.md
  - License: license.md
plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
theme:
  name: material
  feature:
    tabs: true
  highlightjs: true
  features:
    - content.code.copy
  hljs_languages:
    - python
    - yaml
    - bash
    - json
    - markdown
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: deep orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: deep orange
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/neurobionics/opensourceleg
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/opensourceleg

markdown_extensions:
  - attr_list
  - pymdownx.snippets
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

  - toc:
      permalink: true

  - pymdownx.arithmatex:
      generic: true
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true