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

问题描述 投票:14回答:2

(使用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中,只是用它来完成,但这看起来像是一个彻底的黑客,而且很难看。

python python-sphinx
2个回答
19
投票

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

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

从该文本,这样的事情应该这样做:

.. include:: inclusion.txt
   :literal:

10
投票
© www.soinside.com 2019 - 2024. All rights reserved.