python-sphinx - Sphinx ドキュメント: エラー: 不明なディレクティブ タイプ "program-output"

Question

Sphinx でドキュメントを作成しようとしていますが、2 台のマシンでまったく同じ問題が発生しています。プログラム出力ディレクティブが機能しません。

Sphinx をインストールしてから、programoutput 拡張機能をインストールしました。

$ sudo pip install sphinxcontrib-programoutput

インストールはうまくいき、ドキュメントは見栄えの良い html に美しくコンパイルされますが、コマンド出力は機能しません。

test.rst1行を含む という名前のファイルを使用して、非常に単純なテスト ケースを作成しました。

.. program-output:: python -V

これをコンパイルしようとすると、次の出力が得られます (パスは省略されています)。

/path/to/test.rst:1: ERROR: Unknown directive type "program-output".

プログラム出力をそのエイリアスのコマンド出力に変更しても機能しません (驚くことではありません)。ここで何が間違っているのだろうか。--upgradeインストール手順に従い、何度も試し、フラグを付けて再インストールしましたが、何も機能しません。

Answer 1

bmu のおかげで問題が見つかりました。実際、conf.py に追加する必要がありました。

次の質問は、「この拡張機能のインストール/使用方法に関するドキュメントにこれが記載されていないのはなぜですか?」ということです。http://packages.python.org/sphinxcontrib-programoutput/には記載されていません。これは、この拡張機能をグーグルで検索したときに最初に取得するリンクです。

とにかく完全な答えです。他の人にも役立つことを願っています:

~/Projects/project-name/doc残りのドキュメントがあるドキュメントのドキュメント ルート (例: ) に移動します。

ファイルを編集conf.py

という行を探しますextensions = []（私の場合は空のリスト）

これを次のように変更します。extensions = ['sphinxcontrib.programoutput']

そして奇跡的に、それは突然機能し始めます。