include CHANGELOG.md in the documentation

.github/workflows/documentation.yml

@@ -21,7 +21,7 @@ jobs:
           ${{ runner.os }}-
 
     - name: Install Python dependencies
-      run: pip install sphinx sphinx-tabs sphinx-design sphinx_copybutton sphinx_panels sphinx_rtd_theme
+      run: pip install sphinx sphinx-tabs sphinx-design sphinx_copybutton sphinx_panels sphinx_rtd_theme myst_parser
     
     - name: Build HTML docs
       run: |

CHANGELOG.md

@@ -12,7 +12,6 @@ Please add a note of your changes below this heading if you make a Pull Request.
 * Added `<axis>.controller.config.vel_integrator_limit`
 * Allow setting controller gains on CAN Simple
 
-# Releases
 ## [0.5.3] - 2021-09-03
 
 ### Fixed
@@ -31,7 +30,6 @@ Please add a note of your changes below this heading if you make a Pull Request.
 * Firmware boots on devices with unset OTP.
 * Changed CAN heartbeat message to include "trajectory done" flag
 
-# Releases
 ## [0.5.2] - 2021-05-21
 
 ### Fixed
@@ -125,7 +123,6 @@ Please add a note of your changes below this heading if you make a Pull Request.
 * `<odrv>.config.brake_resistance == 0.0` is no longer a valid way to disable the brake resistor. Use `<odrv>.config.enable_brake_resistor` instead. A reboot is necessary for this to take effect.
 * `<odrv>.can.set_baud_rate()` was removed. The baudrate is now automatically updated when writing to `<odrv>.can.config.baud_rate`.
 
-# Releases
 ## [0.5.1] - 2020-09-27
 ### Added
 * Added motor `torque_constant`: units of torque are now [Nm] instead of just motor current.
@@ -203,7 +200,6 @@ Please add a note of your changes below this heading if you make a Pull Request.
 ### Changed
 * Ascii command for reboot changed from `sb` to `sr`.
 
-# Releases
 ## [0.4.10] - 2019-04-24
 ### Fixed
 * Index search would trigger in the wrong place.

docs/changelog.rst

@@ -0,0 +1,9 @@
+.. _changelog:
+
+================================================================================
+CHANGELOG
+================================================================================
+
+
+.. include:: ../CHANGELOG.md
+   :parser: myst_parser.sphinx_

docs/conf.py

@@ -41,7 +41,8 @@ extensions = ['sphinx_tabs.tabs',
     'sphinx.ext.autodoc', # Generate documentation from Python modules
     'sphinx.ext.autosummary', # Generate summary tables for Python documentation
     'sphinx.ext.intersphinx', # Hyperlinks to external projects (such as Python standard library)
-    'fibre_autodoc'# Generate summary tables for Python documentation
+    'fibre_autodoc', # Generate summary tables for Python documentation
+    'myst_parser' # render CHANGELOG markdown file
     
 ]
 

docs/index.rst

@@ -76,3 +76,7 @@ Table of Contents
    configuring-vscode
    configuring-eclipse
 
+.. toctree::
+   :caption: CHANGELOG
+
+   changelog.rst