docs: add changelog (#71)

Co-authored-by: irinaschubert <irina.schubert@dasch.swiss>
dasch-swiss · Jul 22, 2021 · ce1feab · ce1feab
1 parent b884818
commit ce1feab
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 1 deletion.
diff --git a/.github/workflows/test.yml b/.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
diff --git a/Makefile b/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

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -0,0 +1 @@
+{% include-markdown "../CHANGELOG.md" %}
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,3 +1,6 @@
 
 mkdocs
-mkdocs-material
+mkdocstrings
+mkdocs-material
+mkdocs-material-extensions
+mkdocs-include-markdown-plugin
diff --git a/mkdocs.yml b/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