python-sphinx - Python Sphinx によって生成されたドキュメントに動的コンテンツを含める

Question

Sphinx を使用してプロジェクトのドキュメントを生成し、製品のインストール プロセスの一部としてドキュメントを作成しています。

テキストやコード ブロックにホスト名を動的に含めたいと考えています。ドキュメントの説明も、シェルコマンドの出力や特定のファイルの特定の行以外を含めるための機能も見たことがありません。この機能は存在しますか?

Answer 1

これを行うことができる2 つの Sphinx拡張機能を次に示します。

• autorun : ディレクティブで Python コードを実行しrunblock、出力をキャプチャしてドキュメントに挿入します。
• programoutput : ディレクティブを使用して任意のコマンドを実行しprogram-output、出力をドキュメントに挿入します。