Skip to content

Commit e6f5102

Browse files
committed
Use hatch-mkdocs and hatch-pip-compile for docs deps
1 parent 2756a90 commit e6f5102

File tree

4 files changed

+24
-15
lines changed

4 files changed

+24
-15
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ jobs:
1515
- name: Install Python
1616
uses: actions/setup-python@v4
1717
with:
18-
python-version: '3.x'
18+
python-version: '3.11'
1919
- name: Install dependencies
20-
run: pip install --no-deps -r docs/requirements.txt
20+
run: pip install --no-deps -r requirements/requirements-docs.txt
2121
- name: Build site
2222
run: LINT=true mkdocs build --strict
2323
- name: Upload to GitHub Pages

docs/requirements.in

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

hatch.toml

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

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

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,18 @@
11
#
2-
# This file is autogenerated by pip-compile with Python 3.11
3-
# by the following command:
2+
# This file is autogenerated by hatch-pip-compile with Python 3.11
43
#
5-
# pip-compile docs/requirements.in
4+
# - markdown-callouts
5+
# - mkdocs
6+
# - mkdocs-code-validator
7+
# - mkdocs-gen-files
8+
# - mkdocs-literate-nav
9+
# - mkdocs-material
10+
# - mkdocs-section-index
11+
# - mkdocstrings
12+
# - mkdocstrings-crystal
13+
# - pymdown-extensions
614
#
15+
716
babel==2.13.1
817
# via mkdocs-material
918
certifi==2023.7.22

0 commit comments

Comments
 (0)