python - テキストファイルをそのまま (Python) Sphinx Docs に含める

Question

(Python-Sphinx ドキュメンテーションツールを使用)

unaltered.txtに組み込みたいログファイルがあります。、などで何を変更する必要がありますか?_build/html conf.pyindex.rst

レイアウトは次のとおりです。

src/
    index.rst
    some_doc.rst
    somefile.txt

どうすればsomefile.txthtml ビルドに入ることができますか? に次のような行を追加してみましたindex.rst:

Contents:

.. toctree::
   :maxdepth: 2

   some_doc
   "somefile.txt"

魔法でうまくいくことを願っていますが、ここでは魔法はありません!

これが可能であると仮定すると、some_doc.rstそのファイルを参照/リンクするには何を入れますか?

注: はい、/staticに配置してそのまま実行できることは承知していますが、それは完全なハックのようで、醜いようです。

score 27 · Accepted Answer

ここで説明されているように、外部ドキュメントフラグメントを含めることができると思います:

そのテキストから、次のようなものがそれを行うはずです:

.. include:: inclusion.txt
   :literal:

score 10 · Accepted Answer

10

于 2010-05-28T20:12:54.083 に答える

python - テキスト ファイルを *そのまま* (Python) Sphinx Docs に含める