Read The Docs したい
# .readthedocs.yml
version: 2
build:
on: ubuntu-24.04
tools:
python: latest
jobs:
install:
- pip install zensical
build:
html:
- zensical build
post_build:
- mkdir -p $READTHEDOCS_OUTPUT/html/
- cp --recursive site/* $READTHEDOCS_OUTPUT/html/
Read the Docsでもzensicalを使えるようです。
.readthedocs.ymlのbuild.jobs.build.htmlにzensical buildを指定するだけで、ビルドコマンドとしてzensical buildが実行されます。
1# zensical.toml
2[project]
3site_url = "https://PROJECT_NAME.readthedocs.io/"
zensical.tomlの設定で、canonical URLを明記する必要があるようです。
注釈
Read the Docsへの適用はまだですが、ローカル環境でビルドできることは確認しました。
mkdocs.ymlはそのままで、
mkdocsからzensicalに置き換えるだけでOKでした。
Read the Docsでのビルドが成功したら、追記します。