如何使用sphinx首先链接到文件?

Ger*_*Ger 31 restructuredtext python-sphinx

我正在撰写文档,我想包含pdf文件或zip档案的链接.如何使用第一语言和狮身人面像实现这一目标?

如果我这样做

here is a pdf file : `pdf <doc/mypdf.pdf>`_
Run Code Online (Sandbox Code Playgroud)

它不起作用,因为在编译期间sphinx不复制doc目录的包含(我使用sphinx-quickstart生成的makefile).

相反,使用image指令:

.. image:: img/plop.png
Run Code Online (Sandbox Code Playgroud)

sphinx会在构建目录中复制plop.png图像.如何获得pdf或zip存档的相同行为?

Ger*_*Ger 47

我在sphinx文档中找到了解决方案.

假设您mypdf.pdf在目录中有一个文件,这是一个简短的示例doc.目录doc和第一个文件必须位于同一目录中:

here is a pdf file :download:`pdf <doc/mypdf.pdf>`
Run Code Online (Sandbox Code Playgroud)

请注意,您不能:download:在文件的路径和文件的路径之间放置空格.

  • 我添加了简短的例子. (6认同)
  • 请包括实际的解决方案.只需一行就可以了.堆栈溢出时不鼓励仅链接的答案:即使你指向官方文档,他们也会在一段时间内完成404 :-) (3认同)