python - 在 (Python) Sphinx Docs 中包含原样的文本文件

Question

（使用 Python-Sphinx 文档工具）

我有一个.txt想要构建到_build/html unaltered中的日志文件。我需要在 , 等中更改conf.py什么index.rst？

这是布局：

src/
    index.rst
    some_doc.rst
    somefile.txt

如何somefile.txt进入 html 构建？我尝试将这样的行添加到index.rst：

Contents:

.. toctree::
   :maxdepth: 2

   some_doc
   "somefile.txt"

希望它能通过魔法起作用，但这里没有魔法！

假设这甚至是可能的，我会输入什么some_doc.rst来引用/链接到该文件？

注意是的，我知道我可以将它放在/static中，然后就可以完成它，但这似乎完全是 hack，而且丑陋。

score 27 · Accepted Answer

我认为您可以包含一个外部文档片段，如下所述：

从该文本中，应该这样做：

.. include:: inclusion.txt
   :literal:

score 10 · Accepted Answer

10

于 2010-05-28T20:12:54.083 回答

score 0 · Accepted Answer

您可以在 sphinx 中使用以下内容

.. literalinclude:: file.txt
   :text:

它将显示文件的内容，就好像它在代码块中一样。

python - 在 (Python) Sphinx Docs 中包含*原样*的文本文件