在(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:

Answer 2

正确的答案是:download:角色.

Cf: Georg对Sphinx邮件列表的回答