ドキュメント用タスク(task docs)
$ task docs:serve
$ task docs:build
docs:serveは、ドキュメントをローカルでプレビューするタスク、
docs:buildは、静的HTMLをビルドするタスクに割り当てています。
どのプロジェクトでも同じタスク名でドキュメント関連の操作ができるようになります。
Sphinxしたい
tasks:
docs:
desc: Preview docs locally
dir: docs
cmds:
- uv run make livehtml
docs:build:
desc: Build docs as static HTML
dir: docs
cmds:
- uv run make html
docs:pdf:
desc: Build docs as PDF
dir: docs
cmds:
- uv run make latexpdf
make livehtmlは、sphinx-autobuildを使ってSphinxドキュメントをライブプレビューする設定です。
通常は、ドキュメントのあるディレクトリ(docs)に移動してからmake livehtmlコマンドを実行する必要があります。
このタスクを設定すると、どのディレクトリからでもtask docで確認できるようになります。
MkDocsしたい
tasks:
# Documentation
docs:
desc: Preview docs locally
cmds:
- uv run mkdocs serve -o
docs:build:
desc: Build docs as static HTML
cmds:
- uv run mkdocs build
参考
Zensicalしたい
tasks:
# Documentation
docs:
desc: Preview docs locally
cmds:
- uv run zensical serve -o
docs:build:
desc: Build docs as static HTML
cmds:
- uv run zensical build
参考