Merge pull request odriverobotics#662 from odriverobotics/sphinx-docs…

…-update
mp1994 · Feb 8, 2022 · e07919c · e07919c
2 parents 8ece19f + d0cf164
commit e07919c
Show file tree

Hide file tree

Showing 111 changed files with 42 additions and 4,034 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -25,14 +25,14 @@ jobs:
 
     - name: Build HTML docs
       run: |
-        cd docs/reStructuredText
+        cd docs
         make html
 
     - name: Upload docs
       uses: ./.github/actions/upload-release
       with:
         release_type: docs
-        src_dir: docs/reStructuredText/_build/html
+        src_dir: docs/_build/html
         do_access_key: ${{ secrets.DIGITALOCEAN_ACCESS_KEY }}
         do_secret_key: ${{ secrets.DIGITALOCEAN_SECRET_KEY }}
         odrive_api_key: ${{ secrets.ODRIVE_API_KEY }}

diff --git a/Firmware/odrive-interface.yaml b/Firmware/odrive-interface.yaml
@@ -259,23 +259,38 @@ interfaces:
 
           Here's an (incomplete) list of baudrates for ODrive v3.x:
           
-            Configured  | Actual        | Error [%]
-           -------------|---------------|-----------
-            1.2 KBps    | 1.2 KBps      | 0
-            2.4 KBps    | 2.4 KBps      | 0
-            9.6 KBps    | 9.6 KBps      | 0
-            19.2 KBps   | 19.195 KBps   | 0.02
-            38.4 KBps   | 38.391 KBps   | 0.02
-            57.6 KBps   | 57.613 KBps   | 0.02
-            115.2 KBps  | 115.068 KBps  | 0.11
-            230.4 KBps  | 230.769 KBps  | 0.16
-            460.8 KBps  | 461.538 KBps  | 0.16
-            921.6 KBps  | 913.043 KBps  | 0.93
-            1.792 MBps  | 1.826 MBps    | 1.9
-            1.8432 MBps | 1.826 MBps    | 0.93
+          +-------------+---------------+-----------+
+          | Configured  | Actual        | Error [%] |
+          +=============+===============+===========+
+          | 1.2 KBps    | 1.2 KBps      | 0         |
+          +-------------+---------------+-----------+
+          | 2.4 KBps    | 2.4 KBps      | 0         |
+          +-------------+---------------+-----------+
+          | 9.6 KBps    | 9.6 KBps      | 0         |
+          +-------------+---------------+-----------+
+          | 19.2 KBps   | 19.195 KBps   | 0.02      |
+          +-------------+---------------+-----------+
+          | 38.4 KBps   | 38.391 KBps   | 0.02      |
+          +-------------+---------------+-----------+
+          | 57.6 KBps   | 57.613 KBps   | 0.02      |
+          +-------------+---------------+-----------+
+          | 115.2 KBps  | 115.068 KBps  | 0.11      |
+          +-------------+---------------+-----------+
+          | 230.4 KBps  | 230.769 KBps  | 0.16      |
+          +-------------+---------------+-----------+
+          | 460.8 KBps  | 461.538 KBps  | 0.16      |
+          +-------------+---------------+-----------+
+          | 921.6 KBps  | 913.043 KBps  | 0.93      |
+          +-------------+---------------+-----------+
+          | 1.792 MBps  | 1.826 MBps    | 1.9       |
+          +-------------+---------------+-----------+
+          | 1.8432 MBps | 1.826 MBps    | 0.93      |
+          +-------------+---------------+-----------+
+
 
           For more information refer to Section 30.3.4 and Table 142 (the column with f_PCLK = 42 MHz) in the
-          [STM datasheet](https://www.st.com/content/ccc/resource/technical/document/reference_manual/3d/6d/5a/66/b4/99/40/d4/DM00031020.pdf/files/DM00031020.pdf/jcr:content/translations/en.DM00031020.pdf).
+          `STM datasheet <https://www.st.com/content/ccc/resource/technical/document/reference_manual/3d/6d/5a/66/b4/99/40/d4/DM00031020.pdf/files/DM00031020.pdf/jcr:content/translations/en.DM00031020.pdf>`__.
+
       uart_b_baudrate:
         type: uint32
         unit: baud/s

diff --git a/docs/CNAME b/docs/CNAME
diff --git a/docs/Gemfile b/docs/Gemfile
diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock
diff --git a/docs/reStructuredText/Makefile → docs/Makefile b/docs/reStructuredText/Makefile → docs/Makefile
diff --git a/docs/_config.yaml b/docs/_config.yaml