Skip to content

Commit 9dc27c6

Browse files
Switch docs to Zensical
1 parent d8af0a6 commit 9dc27c6

8 files changed

Lines changed: 497 additions & 373 deletions

File tree

.github/workflows/docs.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Documentation
2+
on:
3+
push:
4+
branches:
5+
- master
6+
- main
7+
permissions:
8+
contents: read
9+
pages: write
10+
id-token: write
11+
jobs:
12+
deploy:
13+
environment:
14+
name: github-pages
15+
url: ${{ steps.deployment.outputs.page_url }}
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: actions/configure-pages@v6
19+
- uses: actions/checkout@v6
20+
- uses: actions/setup-python@v6
21+
with:
22+
python-version: 3.x
23+
- run: pip install zensical
24+
- run: zensical build --clean
25+
- uses: actions/upload-pages-artifact@v5
26+
with:
27+
path: site
28+
- uses: actions/deploy-pages@v5
29+
id: deployment

.readthedocs.yml

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
1-
version: 2
1+
version: 2
22

3-
build:
3+
build:
44
os: ubuntu-24.04
55
tools:
6-
python: "3.13"
6+
python: latest
77
jobs:
8-
pre_create_environment:
9-
- asdf plugin add uv
10-
- asdf install uv latest
11-
- asdf global uv latest
12-
create_environment:
13-
- uv venv "${READTHEDOCS_VIRTUALENV_PATH}"
14-
install:
15-
- UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv sync --frozen --group docs
16-
17-
mkdocs:
18-
configuration: mkdocs.yml
19-
fail_on_warning: false
8+
# We recommend using a requirements file for reproducible builds.
9+
# This is just a quick example to get started.
10+
# https://docs.readthedocs.io/page/guides/reproducible-builds.html
11+
install:
12+
- pip install zensical
13+
build:
14+
html:
15+
- zensical build
16+
post_build:
17+
- mkdir -p $READTHEDOCS_OUTPUT/html/
18+
- cp --recursive site/* $READTHEDOCS_OUTPUT/html/

Justfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ build: clean
2323
# Build docs
2424
[group('Build')]
2525
build-docs: clean
26-
uv run mkdocs build
26+
uv run zensical build
2727

2828

2929
# Static analysis
@@ -63,4 +63,4 @@ version:
6363
tag:
6464
echo "Tagging version v{{ VERSION }}"
6565
git tag -a v{{ VERSION }} -m "Creating version v{{ VERSION }}"
66-
git push origin v{{ VERSION }}
66+
git push origin v{{ VERSION }}

docs/js/readthedocs.js

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

mkdocs.yml

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

pyproject.toml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,8 @@ dev = [
5757
"ruff>=0.12.11",
5858
]
5959
docs = [
60-
"mkdocs>=1.6.1",
61-
"mkdocs-material>=9.7.0",
6260
"pyyaml-env-tag>=1.1",
61+
"zensical>=0.0.44",
6362
]
6463

6564
[tool.mypy]

uv.lock

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

0 commit comments

Comments
 (0)