Skip to content

Commit 519aaee

Browse files
committed
docs: define mkdocs dependencies in requirements-mkdocs.txt
1 parent 40d17ec commit 519aaee

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

.github/workflows/main.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,5 @@ jobs:
1313
- uses: actions/setup-python@v2
1414
with:
1515
python-version: 3.x
16-
- run: pip install mkdocs-material
17-
- run: pip install mkdocs-redirects
18-
- run: pip install mkdocs-git-revision-date-localized-plugin
16+
- run: pip3 install -r requirements-mkdocs.txt
1917
- run: mkdocs gh-deploy --force

docs/Developers/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,9 @@
44

55
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.
66

7-
Setup your system for Material:
7+
Setup your system for mkdocs and Material:
88
```
9-
pip3 install mkdocs-material
10-
pip3 install mkdocs-git-revision-date-localized-plugin
9+
pip3 install -r requirements-mkdocs.txt
1110
```
1211

1312
To test your local changes while writing them and before making a pull-request:

requirements-mkdocs.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
mkdocs-material
2+
mkdocs-material-extensions
3+
mkdocs-redirects

0 commit comments

Comments
 (0)