From 58bc9b3e1f6b1dfa4ebeacdf9276e9923e93d180 Mon Sep 17 00:00:00 2001 From: rbpatt2019 Date: Fri, 11 Jun 2021 13:51:38 +0100 Subject: [PATCH] docs(index): add changelog Adds link to changelog to documentation index. Currently, there is no option to format the python semantic release Changelog as rst, and the myst_parser for Sphinx (appears to) require the whole documentation to be in Markdown. As such, a simple rst include directive doesn't work here. Until one of the 2 above issues gets sorted, we default to linking to the Github release history, which contains the whole changelog. --- docs/index.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/index.rst b/docs/index.rst index b6660c8..05ba387 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -47,8 +47,11 @@ If you want to learn more about the analysis, you should look at :ref:`analysis`. The source code documentation lives at :ref:`source`. If testing is your thing, peek at :ref:`testing`. +A full changelog can be found with the `release history`_. And you can learn about contributing at :ref:`contributing`. +.. _release history: https://github.com/IMS-Bio2Core-Facility/BIC086/releases + Welcome! .. toctree::