自動ビルドしたい(sphinx-autobuild

$ pip3 install sphinx-autobuild
$ cd プロジェクト名/docs
$ sphinx-autobuild source/ build/html/

sphinx-autobuildを使うと、ライブリロードしながら編集できます。

さらに自動化したい

# ...(省略)...
%: Makefile
	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

livehtml:
	sphinx-autobuild --open-browser "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

Makefileの末尾に上記のコマンドを追記しておくと便利です。 ターミナル上でmake livehtmlを実行すると、ブラウザでhttp://127.0.0.1:8000が開くようになります。 docs以下のファイルを編集して保存するたびにSphinxが実行され、ブラウザ表示も更新されます。

ページがうまく更新できない場合は、ビルド時にエラーが発生している可能性があります。 まずターミナル上の表示を確認してください。

$ cd docs
$ make livehtml
...(省略)...
[I 230520 23:34:44 server:335] Serving on http://127.0.0.1:8000
[I 230520 23:34:44 handlers:62] Start watching changes
[I 230520 23:34:44 handlers:64] Start detecting changes