相关疑难解决方法(0)

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

我正在使用sphinx和RST将一些技术文档生成为 HTML，并且在将本地 PDF 引用用作超链接时遇到问题。我见过人们:download:用来链接到本地​​ PDF，但我将 PDF 嵌入到/docs目录中以供参考。我不喜欢，:download:因为它不会在浏览器中内嵌显示 PDF，这需要代表用户执行额外的步骤才能使用。

sphinx-build -b html除非在config.pyhookhtml_static_path或html_extra_path-中指定，否则不会复制任何文件，即使这样，它们也会被放到root目录或_static文件夹中。

是否有在 sphinx 中嵌入链接二进制文件的建议方法，或者这是一种不好的做法？通常，这些链接指向未托管在其他任何地方的幻灯片或设计图。

链接 PDF 的示例 RST

.. important:: View the agile course on scrum basics

    - View `these slides to dive deeper into Agile Basics <docs/agile-101.pdf>`_.