Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add changelog #71

Merged
merged 8 commits into from Jul 22, 2021
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/test.yml
Expand Up @@ -42,3 +42,6 @@ jobs:
make install-requirements
make install
make test
- name: build docs
run: |
make build-docs
1 change: 1 addition & 0 deletions Makefile
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/changelog.md
@@ -0,0 +1 @@
{% include-markdown "../CHANGELOG.md" %}
5 changes: 4 additions & 1 deletion docs/requirements.txt
@@ -1,3 +1,6 @@

mkdocs
mkdocs-material
mkdocstrings
mkdocs-material
mkdocs-material-extensions
mkdocs-include-markdown-plugin
5 changes: 5 additions & 0 deletions mkdocs.yml
Expand Up @@ -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
Expand All @@ -25,3 +26,7 @@ theme:
tabs: false
extra_css:
- 'assets/style/theme.css'

plugins:
- search
- include-markdown