Skip to content

Commit

Permalink
docs: define mkdocs dependencies in requirements-mkdocs.txt
Browse files Browse the repository at this point in the history
  • Loading branch information
ukkopahis committed Feb 24, 2022
1 parent 40d17ec commit 519aaee
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
4 changes: 1 addition & 3 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,5 @@ jobs:
- uses: actions/setup-python@v2
with:
python-version: 3.x
- run: pip install mkdocs-material
- run: pip install mkdocs-redirects
- run: pip install mkdocs-git-revision-date-localized-plugin
- run: pip3 install -r requirements-mkdocs.txt
- run: mkdocs gh-deploy --force
5 changes: 2 additions & 3 deletions docs/Developers/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,9 @@

Documentation is is written as markdown, processed using mkdocs ([docs](https://www.mkdocs.org/user-guide/writing-your-docs/#writing-your-docs)) and the Material theme ([docs](https://squidfunk.github.io/mkdocs-material/reference/)). The Material theme is not just styling, but provides additional syntax extensions.

Setup your system for Material:
Setup your system for mkdocs and Material:
```
pip3 install mkdocs-material
pip3 install mkdocs-git-revision-date-localized-plugin
pip3 install -r requirements-mkdocs.txt
```

To test your local changes while writing them and before making a pull-request:
Expand Down
3 changes: 3 additions & 0 deletions requirements-mkdocs.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
mkdocs-material
mkdocs-material-extensions
mkdocs-redirects

0 comments on commit 519aaee

Please sign in to comment.