diff --git a/docs/changelog.md b/docs/changelog.md deleted file mode 100644 index 1a7157a..0000000 --- a/docs/changelog.md +++ /dev/null @@ -1,5 +0,0 @@ -# Changelog - -## [0.3.0] - 2021-09-20 - -Initial release. \ No newline at end of file diff --git a/docs/changelog.rst b/docs/changelog.rst new file mode 100644 index 0000000..b3dd05a --- /dev/null +++ b/docs/changelog.rst @@ -0,0 +1,9 @@ +Changelog +========= + +- :bug:`0` Retagged previous versions using pure Semantic Versioning +- :feature:`0` Documentation for kami::RandomScheduler +- :feature:`0` Added a changelog! + +- :release:`0.3.0 <2021.09.20>` +- :feature:`0` Initial public release. \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index deabcac..48fc175 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -43,7 +43,11 @@ extensions = [ 'sphinx.ext.githubpages', 'breathe', 'exhale', - 'myst_parser'] + 'myst_parser', + 'releases'] + +# 'releases' (changelog) settings +releases_github_path = "JHUAPL/kami" # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/docs/requirements.txt b/docs/requirements.txt index b2642c3..89d956c 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -4,3 +4,5 @@ exhale documenteer myst-parser sphinx_bootstrap_theme +sphinx_rtd_theme +git+https://github.com/bitprophet/releases/#egg=releases