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

Question

(使用 Python-Sphinx 文档工具)

我有一个 .txt 日志文件，我想将其构建到 _build/html 未更改 中。我需要在 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 中，然后就可以了，但这似乎完全是黑客攻击，而且很丑陋。

Answer 1

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

http://docutils.sourceforge.net/docs/ref/rst/directives.html#including-an-external-document-fragment

根据该文本，应该这样做:

.. include:: inclusion.txt
   :literal: