Skip to content

Commit 8ec84ef

Browse files
authored
Migrate documentation from MkDocs to Zensical (#352)
1 parent d7af81c commit 8ec84ef

6 files changed

Lines changed: 199 additions & 339 deletions

File tree

‎.github/workflows/docs.yml‎

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,20 @@ jobs:
1212
runs-on: ubuntu-latest
1313

1414
permissions:
15-
contents: write
15+
contents: read
16+
pages: write
17+
id-token: write
18+
19+
environment:
20+
name: github-pages
21+
url: ${{ steps.deployment.outputs.page_url }}
1622

1723
steps:
18-
# `mkdocs gh-deploy` pushes the built docs to `gh-pages`, so this job needs
19-
# a real checkout with the authenticated origin remote preserved.
20-
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6.0.2 # zizmor: ignore[artipacked]
24+
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
25+
with:
26+
persist-credentials: false
2127

22-
- name: Configure Git Credentials
23-
run: |
24-
git config user.name github-actions[bot]
25-
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
28+
- uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0
2629

2730
- name: Install uv
2831
uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
@@ -36,4 +39,11 @@ jobs:
3639
- name: Install dependencies
3740
run: uv sync --frozen
3841

39-
- run: uv run mkdocs gh-deploy --force
42+
- run: uv run zensical build --clean
43+
44+
- uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
45+
with:
46+
path: site
47+
48+
- uses: actions/deploy-pages@368f82528645a54fb793d4d04e342629a3f51346 # v5.0.1
49+
id: deployment

‎.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ venv.bak/
176176
# Rope project settings
177177
.ropeproject
178178

179-
# mkdocs documentation
179+
# zensical documentation
180180
/site
181181

182182
# mypy

‎mkdocs.yml‎

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

‎pyproject.toml‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,8 @@ dev = [
5252
"types-PyYAML",
5353
"atheris==2.3.0; python_version <= '3.11'",
5454
# Documentation
55-
"mkdocs",
56-
"mkdocs-material",
55+
"zensical",
5756
"mkdocstrings-python",
58-
"mkdocs-autorefs",
5957
"pymdown-extensions>=10.21.2",
6058
]
6159

@@ -124,4 +122,4 @@ exclude_also = [
124122
]
125123

126124
[tool.check-sdist]
127-
git-only = ["docs", "fuzz", "scripts", "mkdocs.yml", "uv.lock", "SECURITY.md"]
125+
git-only = ["docs", "fuzz", "scripts", "zensical.toml", "uv.lock", "SECURITY.md"]

0 commit comments

Comments
 (0)