Skip to content

Commit db9862e

Browse files
authored
fix: docs build (#182)
1 parent 62be141 commit db9862e

File tree

3 files changed

+306
-3
lines changed

3 files changed

+306
-3
lines changed

.github/workflows/publish_docs.yml

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,25 @@ jobs:
1717
url: ${{ steps.deployment.outputs.page_url }}
1818
steps:
1919
- uses: actions/checkout@v5
20+
2021
- uses: actions/setup-python@v5
2122
with:
22-
python-version: '3.12'
23-
- run: pip install mkdocs mkdocs-material mkdocstrings[python]
24-
- run: mkdocs build
23+
python-version: '3.11'
24+
25+
- name: Install uv
26+
uses: astral-sh/setup-uv@v5
27+
28+
- name: Install project and docs dependencies
29+
run: make install
30+
31+
- name: Build documentation
32+
run: uv run mkdocs build
33+
2534
- uses: actions/configure-pages@v5
35+
2636
- uses: actions/upload-pages-artifact@v3
2737
with:
2838
path: ./site
39+
2940
- id: deployment
3041
uses: actions/deploy-pages@v4

pyproject.toml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,12 @@ types = [
7676
"pandas-stubs",
7777
]
7878

79+
docs = [
80+
"mkdocs",
81+
"mkdocs-material",
82+
"mkdocstrings[python]",
83+
]
84+
7985
[project.optional-dependencies]
8086
redis = ["redis>=4.0.0"]
8187

0 commit comments

Comments
 (0)