docs: add changelog (#71)

Co-authored-by: irinaschubert <irina.schubert@dasch.swiss>

Author: subotic

.github/workflows/test.yml

@@ -42,3 +42,7 @@ jobs:
           make install-requirements
           make install
           make test
+      - name: build docs
+        run: |
+          make install-requirements
+          make build-docs

Makefile

@@ -49,6 +49,7 @@ publish-docs: ## build and publish docs to Github Pages
 .PHONY: install-requirements
 install-requirements: ## install requirements
 	pip3 install -r requirements.txt
+	pip3 install -r docs/requirements.txt
 
 .PHONY: install
 install: ## install from source

docs/changelog.md

@@ -0,0 +1 @@
+{% include-markdown "../CHANGELOG.md" %}

docs/requirements.txt

@@ -1,3 +1,6 @@
 
 mkdocs
-mkdocs-material
+mkdocstrings
+mkdocs-material
+mkdocs-material-extensions
+mkdocs-include-markdown-plugin

mkdocs.yml

@@ -13,6 +13,7 @@ nav:
     - Bulk data import: dsp-tools-xmlupload.md
     - Excel file processing: dsp-tools-excel.md
     - Information for developers: dsp-tools-information-for-developers.md
+    - Changelog: changelog.md
 
 theme:
   name: material
@@ -25,3 +26,7 @@ theme:
     tabs: false
 extra_css:
   - 'assets/style/theme.css'
+
+plugins:
+  - search
+  - include-markdown