在(Python)Sphinx Docs中包含文本文件*

时间:2010-05-27 13:56:04

标签: python python-sphinx

(使用Python-Sphinx文档工具)

我有一个.txt日志文件,我想在_build/html 未修改中构建。我需要在conf.pyindex.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 中,只需完成它, 但这似乎完全是黑客,而且丑陋。

2 个答案:

答案 0 :(得分:18)

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

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

从那篇文章中可以看出这样的事情:

.. include:: inclusion.txt
   :literal:

答案 1 :(得分:11)