コードベース全体に対して多数のHTMLドキュメントを生成するSphinx構成があります。時々、私は1つのファイルで作業していて、スイート全体を実行せずに構文が正しいことを確認するために、そのファイルからのHTML出力を確認したいだけです。
この1つのファイルでスフィンクスを実行するためにターミナルで実行できる最も単純なコマンドを探しました。情報はそこにあると確信していますが、表示されませんでした。
コードベース全体に対して多数のHTMLドキュメントを生成するSphinx構成があります。時々、私は1つのファイルで作業していて、スイート全体を実行せずに構文が正しいことを確認するために、そのファイルからのHTML出力を確認したいだけです。
この1つのファイルでスフィンクスを実行するためにターミナルで実行できる最も単純なコマンドを探しました。情報はそこにあると確信していますが、表示されませんでした。
Sphinx は reST ファイルを処理します (Python ファイルを直接処理するのではありません)。これらのファイルには、Python モジュールへの参照が含まれている場合があります (autodoc を使用する場合)。私の経験では、前回の完全な出力ビルド以降に変更された Python モジュールが 1 つだけの場合、Sphinx はすべてを再生成するわけではありません。その特定の Python モジュールを「取り込む」reST ファイルのみが処理されます。というメッセージがありますupdating environment: 0 added, 1 changed, 0 removed
。
単一の reST ファイルを明示的に処理するには、それを の引数として指定しますsphinx-build
。
sphinx-build -b html -d _build/doctrees . _build/html your_filename.rst