Merge pull request #320 from neurobionics/feature/documentation

Merge documentation updates with Main
neurobionics · Feb 26, 2025 · 5553096 · 5553096
2 parents 38d216b + ecdbd77
commit 5553096
Show file tree

Hide file tree

Showing 43 changed files with 3,205 additions and 286 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/assets/.DS_Store b/assets/.DS_Store
diff --git a/docs/modules.md b/docs/modules.md
diff --git a/docs/modules/actuators/actuators.md b/docs/modules/actuators/actuators.md
@@ -0,0 +1 @@
+::: opensourceleg.actuators.base
diff --git a/docs/modules/actuators/dephy.md b/docs/modules/actuators/dephy.md
@@ -0,0 +1 @@
+::: opensourceleg.actuators.dephy
diff --git a/docs/modules/actuators/moteus.md b/docs/modules/actuators/moteus.md
@@ -0,0 +1 @@
+::: opensourceleg.actuators.moteus
diff --git a/docs/modules/actuators/tmotor.md b/docs/modules/actuators/tmotor.md
@@ -0,0 +1 @@
+::: opensourceleg.actuators.tmotor
diff --git a/docs/modules/collections/validators.md b/docs/modules/collections/validators.md
@@ -0,0 +1 @@
+::: opensourceleg.collections.validators
diff --git a/docs/modules/control/compiled_controller.md b/docs/modules/control/compiled_controller.md
@@ -0,0 +1 @@
+::: opensourceleg.control.compiled_controller
diff --git a/docs/modules/control/state_machine.md b/docs/modules/control/state_machine.md
@@ -0,0 +1 @@
+::: opensourceleg.control.state_machine
diff --git a/docs/modules/logging.md b/docs/modules/logging.md
@@ -0,0 +1 @@
+::: opensourceleg.logging
diff --git a/docs/modules/robots/osl.md b/docs/modules/robots/osl.md
@@ -0,0 +1 @@
+::: opensourceleg.robots.osl
diff --git a/docs/modules/robots/robots.md b/docs/modules/robots/robots.md
@@ -0,0 +1 @@
+::: opensourceleg.robots.base
diff --git a/docs/modules/safety.md b/docs/modules/safety.md
@@ -0,0 +1 @@
+::: opensourceleg.safety
diff --git a/docs/modules/sensors/adc.md b/docs/modules/sensors/adc.md
@@ -0,0 +1 @@
+::: opensourceleg.sensors.adc
diff --git a/docs/modules/sensors/encoder.md b/docs/modules/sensors/encoder.md
@@ -0,0 +1 @@
+::: opensourceleg.sensors.encoder
diff --git a/docs/modules/sensors/imu.md b/docs/modules/sensors/imu.md
@@ -0,0 +1 @@
+::: opensourceleg.sensors.imu
diff --git a/docs/modules/sensors/loadcell.md b/docs/modules/sensors/loadcell.md
@@ -0,0 +1 @@
+::: opensourceleg.sensors.loadcell
diff --git a/docs/modules/sensors/sensors_base.md b/docs/modules/sensors/sensors_base.md
@@ -0,0 +1 @@
+::: opensourceleg.sensors.base
diff --git a/docs/modules/time.md b/docs/modules/time.md
@@ -0,0 +1 @@
+::: opensourceleg.time
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -9,7 +9,30 @@ copyright: Maintained by <a href="https://github.com/senthurayyappan">Senthur Ay
 
 nav:
   - Overview: index.md
-  - Modules: modules.md
+  - Modules:
+      - Actuators:
+          - Base: modules/actuators/actuators.md
+          - Dephy: modules/actuators/dephy.md
+          - Moteus: modules/actuators/moteus.md
+          - TMotor: modules/actuators/tmotor.md
+      - Collections:
+          - Validators: modules/collections/validators.md
+      - Control:
+          - Compiled Controller: modules/control/compiled_controller.md
+          - State Machine: modules/control/state_machine.md
+      - Logging:
+          - Logger: modules/logging.md
+      - Sensors:
+          - Base: modules/sensors/sensors_base.md
+          - IMU: modules/sensors/imu.md
+          - Loadcell: modules/sensors/loadcell.md
+          - ADC: modules/sensors/adc.md
+          - Encoder: modules/sensors/encoder.md
+      - Robots:
+          - Base: modules/robots/robots.md
+          - OSL: modules/robots/osl.md
+      - Safety: modules/safety.md
+      - Time: modules/time.md
 plugins:
   - search
   - mkdocstrings:
@@ -22,6 +45,13 @@ theme:
   name: material
   feature:
     tabs: true
+  highlightjs: true
+  hljs_languages:
+    - python
+    - yaml
+    - bash
+    - json
+    - markdown
   palette:
     - media: "(prefers-color-scheme: light)"
       scheme: default
@@ -48,7 +78,16 @@ extra:
       link: https://pypi.org/project/opensourceleg
 
 markdown_extensions:
+  - attr_list
+  - pymdownx.snippets
+  - pymdownx.highlight # For syntax highlighting
+  - pymdownx.superfences
+
   - toc:
       permalink: true
+
   - pymdownx.arithmatex:
       generic: true
+  - def_list
+  - pymdownx.tasklist:
+      custom_checkbox: true