From 59ccc7234374d31503ef0c385c8b3a19df7f792d Mon Sep 17 00:00:00 2001 From: nick-a-schneider Date: Wed, 1 Jun 2022 17:23:50 -0400 Subject: [PATCH] include CHANGELOG.md in the documentation --- .github/workflows/documentation.yml | 2 +- CHANGELOG.md | 4 ---- docs/changelog.rst | 9 +++++++++ docs/conf.py | 3 ++- docs/index.rst | 4 ++++ 5 files changed, 16 insertions(+), 6 deletions(-) create mode 100644 docs/changelog.rst diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index fa9c114f..f957a612 100644 --- a/.github/workflows/documentation.yml +++ b/.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: | diff --git a/CHANGELOG.md b/CHANGELOG.md index aea5d86a..d87e5a9a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,7 +12,6 @@ Please add a note of your changes below this heading if you make a Pull Request. * Added `.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. * `.config.brake_resistance == 0.0` is no longer a valid way to disable the brake resistor. Use `.config.enable_brake_resistor` instead. A reboot is necessary for this to take effect. * `.can.set_baud_rate()` was removed. The baudrate is now automatically updated when writing to `.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. diff --git a/docs/changelog.rst b/docs/changelog.rst new file mode 100644 index 00000000..58740ed6 --- /dev/null +++ b/docs/changelog.rst @@ -0,0 +1,9 @@ +.. _changelog: + +================================================================================ +CHANGELOG +================================================================================ + + +.. include:: ../CHANGELOG.md + :parser: myst_parser.sphinx_ \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index c55701ae..d9c63ace 100644 --- a/docs/conf.py +++ b/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 ] diff --git a/docs/index.rst b/docs/index.rst index 8f055e0f..ec046b19 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -76,3 +76,7 @@ Table of Contents configuring-vscode configuring-eclipse +.. toctree:: + :caption: CHANGELOG + + changelog.rst \ No newline at end of file