Skip to content

Commit 9ab21c8

Browse files
authored
Migrate documentation build from MkDocs to Zensical (#2679)
* docs: migrate documentation build from mkdocs to zensical * docs: update build command to include --clean option for zensical
1 parent c8f8744 commit 9ab21c8

4 files changed

Lines changed: 49 additions & 214 deletions

File tree

.github/workflows/docs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ jobs:
2222
- name: Install dependencies
2323
run: uv sync
2424
- name: build site
25-
run: mkdocs build --verbose --clean --strict
25+
run: zensical build --clean
2626
- name: Deploy
2727
uses: peaceiris/actions-gh-pages@v2
2828
env:

pyproject.toml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,7 @@ type = [
102102
{ include-group = "test" },
103103
]
104104
docs = [
105-
"mkdocs>=1.6",
106-
"mkdocs-material>=9.5.31",
105+
"zensical>=0.0.11; python_version>='3.10'",
107106
]
108107
black22 = [ "black==22.1" ]
109108
black23 = [ "black==23.12" ]

tox.ini

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,8 @@ dependency_groups = type
122122
description = generate documentation
123123
extras =
124124
commands =
125-
mkdocs build --verbose --clean --strict -d {posargs:{env_tmp_dir}}
126-
python -c 'print("Documentation generated at file://{posargs:{env_tmp_dir}}{/}index.html")'
125+
zensical build
126+
python -c 'print("Documentation generated at file://{tox_root}{/}site{/}index.html")'
127127
dependency_groups = docs
128128

129129
[testenv:dev]

0 commit comments

Comments
 (0)