ビルドしたい（sphinx-build）

$ sphinx-build --builder html SOURCE_DIR BUILD_DIR
$ sphinx-build --builder dirhtml SOURCE_DIR BUILD_DIR
$ sphinx-build --builder latex SOURCE_DIR BUILD_DIR

sphinx-buildコマンドで、Sphinxドキュメントをビルドできます。 --builderオプションで、ビルド形式を変更できます。

// 利用可能なビルダーを確認する
$ make help
$ make html
$ make dirhtml
$ make latexpdf

sphinx-quickstartコマンドでプロジェクトを作成した場合は、 Makefileが自動生成されます。 make helpコマンドで、利用可能なビルダーを確認できます。

重要

ゆくゆくはMakefileに依存しないsphinxコマンドを作る予定のようです。 （GitHubのみたので、Issue番号が分かればはる）

KumaROOTをビルドしたい

// GitHubにあるリポジトリをクローンする
$ git clone https://github.com/shotakaha/kumaroot.git
$ cd kumaroot
$ uv sync

$ cd docs
$ uv run make html
$ uv run make latexpdf

KumaROOTのドキュメントをビルドする手順です。

注釈

Python開発環境の構築にuvを使っています。 詳しくはパッケージ管理したい（uv）を参照してください。

$ git clone https://github.com/shotakaha/kumaroot.git
$ cd kumaroot
$ uv sync

$ task docs:build    // uv run make html
$ task docs:pdf      // uv run make latexpdf
$ task docs:serve    // uv run make livehtml

現在はtaskコマンドを使って、 より簡単にビルドできるようにしています。