Skip to content

Commit 69b62e0

Browse files
committed
migrate docs workflow from MkDocs CLI to Zensical
- switch docs CI build step to `uv run zensical build` - update README and docs commands to use `zensical serve/build` - replace MkDocs-oriented dev deps with `zensical` and `mkdocstrings-python` - regenerate `uv.lock` to reflect dependency graph changes - ignore generated `site/` output
1 parent 70dee9a commit 69b62e0

6 files changed

Lines changed: 59 additions & 149 deletions

File tree

.github/workflows/docs.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ jobs:
2525
- name: Install dependencies
2626
run: uv sync --group dev
2727

28-
- name: Build docs (strict)
29-
run: uv run mkdocs build --strict
28+
- name: Build docs
29+
run: uv run zensical build
3030

3131
- name: Link check
3232
uses: lycheeverse/lychee-action@v2
@@ -68,8 +68,8 @@ jobs:
6868
- name: Install dependencies
6969
run: uv sync --group dev
7070

71-
- name: Build docs (strict)
72-
run: uv run mkdocs build --strict
71+
- name: Build docs
72+
run: uv run zensical build
7373

7474
- name: Configure Pages
7575
uses: actions/configure-pages@v5

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ __pycache__/
1010
.Python
1111
build/
1212
dist/
13+
site/
1314
downloads/
1415
eggs/
1516
.eggs/

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,19 +22,19 @@ uv sync
2222

2323
## Documentation
2424

25-
Full docs are built with MkDocs (Material + mkdocstrings) from source code
25+
Full docs are built with Zensical (MkDocs-compatible) + mkdocstrings from source code
2626
docstrings, README guidance, and example workflows.
2727

2828
- hosted site (GitHub Pages): `https://emsi.github.io/codex-app-server-client/`
2929

3030
Local docs commands:
3131

3232
```bash
33-
uv run mkdocs serve
33+
uv run zensical serve
3434
```
3535

3636
```bash
37-
uv run mkdocs build --strict
37+
uv run zensical build
3838
```
3939

4040
## Quick start

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ uv sync
2727
## Local docs workflow
2828

2929
```bash
30-
uv run mkdocs serve
30+
uv run zensical serve
3131
```
3232

3333
```bash
34-
uv run mkdocs build --strict
34+
uv run zensical build
3535
```

pyproject.toml

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,8 @@ build-backend = "hatchling.build"
4141
[project.optional-dependencies]
4242
dev = [
4343
"build>=1.2.2",
44-
"mkdocs>=1.6.1",
45-
"mkdocs-material>=9.6.0",
46-
"mkdocstrings[python]>=0.28.0",
47-
"mkdocs-gen-files>=0.5.0",
48-
"mkdocs-literate-nav>=0.6.1",
49-
"mkdocs-section-index>=0.3.10",
44+
"zensical>=0.0.23",
45+
"mkdocstrings-python>=1.18.2",
5046
"pytest>=8.2.0",
5147
"twine>=6.0.1",
5248
]
@@ -56,12 +52,8 @@ dev = [
5652
"basedpyright>=1.38.1",
5753
"black>=26.1.0",
5854
"build>=1.2.2",
59-
"mkdocs>=1.6.1",
60-
"mkdocs-material>=9.6.0",
61-
"mkdocstrings[python]>=0.28.0",
62-
"mkdocs-gen-files>=0.5.0",
63-
"mkdocs-literate-nav>=0.6.1",
64-
"mkdocs-section-index>=0.3.10",
55+
"zensical>=0.0.23",
56+
"mkdocstrings-python>=1.18.2",
6557
"mypy>=1.19.1",
6658
"pytest>=9.0.2",
6759
"ruff>=0.15.2",

uv.lock

Lines changed: 45 additions & 128 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)