Skip to content

Commit 8eb37f7

Browse files
committed
Use hatch-mkdocs and hatch-pip-compile for docs deps
1 parent 97924e7 commit 8eb37f7

File tree

4 files changed

+22
-12
lines changed

4 files changed

+22
-12
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ jobs:
1616
- name: Install Python
1717
uses: actions/setup-python@v4
1818
with:
19-
python-version: '3.12'
19+
python-version: '3.11'
2020
- name: Install dependencies
21-
run: pip install --no-deps -r docs/requirements.txt
21+
run: pip install --no-deps -r requirements/requirements-docs.txt
2222
- name: Fetch branch
2323
run: git fetch origin v1:v1
2424
- name: Build site
25-
run: mkdocs build -f docs/mkdocs.yml
25+
run: mkdocs build -f docs/mkdocs.yml --strict
2626
- name: Upload to GitHub Pages
2727
uses: actions/upload-pages-artifact@v2
2828
with:

docs/requirements.in

Lines changed: 0 additions & 6 deletions
This file was deleted.

hatch.toml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
[env]
2+
requires = [
3+
"hatch-mkdocs",
4+
"hatch-pip-compile",
5+
]
6+
7+
[env.collectors.mkdocs.docs]
8+
path = "docs/mkdocs.yml"
9+
[envs.docs]
10+
type = "pip-compile"
11+
pip-compile-hashes = false

docs/requirements.txt renamed to requirements/requirements-docs.txt

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
11
#
2-
# This file is autogenerated by pip-compile with Python 3.12
3-
# by the following command:
2+
# This file is autogenerated by hatch-pip-compile with Python 3.11
43
#
5-
# pip-compile requirements.in
4+
# - mkdocs
5+
# - mkdocs-gen-files
6+
# - mkdocs-macros-plugin
7+
# - mkdocs-material
8+
# - mkdocs-same-dir
9+
# - pymdown-extensions
610
#
11+
712
babel==2.13.0
813
# via mkdocs-material
914
certifi==2023.7.22

0 commit comments

Comments
 (0)