在(Python)Sphinx文档中包含*原样*的文本文件
问题描述
(使用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
中放什么来引用/链接
到该文件?
注意是的,我知道我可以将其放在/静态中,然后就可以使用它了, 但这似乎完全是一种黑客行为,而且很难看。
解决方案
正确答案是:download:
role。
cf:Georg's answer on the Sphinx Mailing List
相关文章