sphinx-doc/sphinx-autobuild

これは何？

主な機能

• 01ソースディレクトリ内のファイルが変更されると、Sphinxのドキュメントを自動で再ビルドします。
• 02ビルドのたびに開いているブラウザーのウィンドウを再読み込みします。
• 03sphinx-buildのすべての引数に加え、サーバーと監視に関するオプションを利用できます。
• 04監視対象ファイルの無視パターンにglobとregexを指定できます。
• 05ビルドの前後に任意のコマンドを実行できます。
• 06空きポートを自動で選び、起動時にブラウザーを開けます。

ユースケース

• プロジェクトのドキュメントを執筆し、変更をすぐに確認する。
• テーマのファイルも監視しながら、カスタムSphinx HTMLテーマを開発する。
• ポートと出力ディレクトリを分けて、複数のドキュメントプロジェクトを同時に実行する。
• ビルド前後のフックを使って、ビルドの開始と完了を通知する。

クイックスタート

1. 1

   pip で PyPI から sphinx-autobuild をインストールします

   pip install sphinx-autobuild
2. 2

   サーバーを起動し、docs ディレクトリの変更を監視します

   sphinx-autobuild docs docs/_build/html

使う前に知っておきたいこと

• !利用するには Sphinx のドキュメントプロジェクトが必要です。

収録されている特集

トピック

よくある質問

sphinx-autobuild とは？

Sphinxのドキュメントディレクトリを監視し、変更時にビルドを実行して、ローカルサーバー経由でブラウザーを再読み込みするCLIツールです。 sphinx-autobuildはSphinxのソースディレクトリを監視し、ファイルが変更されるたびにsphinx-buildを実行します。生成したHTMLはデフォルトでhttp://127.0.0.1:8000のローカルWebサーバーから配信され、ビルドのたびに開いているブラウザーのウィンドウが自動で再読み込みされるため、手動でビルドや更新をしなくても編集内容を確認できます。

sphinx-autobuild は無料で使えますか？ライセンスは？

sphinx-autobuild は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

sphinx-autobuild は今もメンテナンスされていますか？

活発にメンテナンス中。sphinx-autobuild の最終コミットは 2026年10月23日 です。

sphinx-autobuild は何に使えますか？

プロジェクトのドキュメントを執筆し、変更をすぐに確認する。 テーマのファイルも監視しながら、カスタムSphinx HTMLテーマを開発する。 ポートと出力ディレクトリを分けて、複数のドキュメントプロジェクトを同時に実行する。 ビルド前後のフックを使って、ビルドの開始と完了を通知する。

sphinx-autobuild のインストール方法は？

pip で PyPI から sphinx-autobuild をインストールします: pip install sphinx-autobuild サーバーを起動し、docs ディレクトリの変更を監視します: sphinx-autobuild docs docs/_build/html

sphinx-autobuild はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/sphinx-doc/sphinx-autobuild