在(Python)Sphinx文档中包含*原样*的文本文件

Include a text file *as is* in (Python) Sphinx Docs(在(Python)Sphinx文档中包含*原样*的文本文件)
本文介绍了在(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中放什么来引用/链接 到该文件?

注意是的,我知道我可以将其放在/静态中,然后就可以使用它了, 但这似乎完全是一种黑客行为,而且很难看。

推荐答案

正确答案是:download: role。

cf:Georg's answer on the Sphinx Mailing List

这篇关于在(Python)Sphinx文档中包含*原样*的文本文件的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持编程学习网!

本站部分内容来源互联网,如果有图片或者内容侵犯您的权益请联系我们删除!

相关文档推荐

Leetcode 234: Palindrome LinkedList(Leetcode 234:回文链接列表)
How do I read an Excel file directly from Dropbox#39;s API using pandas.read_excel()?(如何使用PANDAS.READ_EXCEL()直接从Dropbox的API读取Excel文件?)
subprocess.Popen tries to write to nonexistent pipe(子进程。打开尝试写入不存在的管道)
I want to realize Popen-code from Windows to Linux:(我想实现从Windows到Linux的POpen-code:)
Reading stdout from a subprocess in real time(实时读取子进程中的标准输出)
How to call type safely on a random file in Python?(如何在Python中安全地调用随机文件上的类型?)