如何使用sphinx在rst中链接到文件？

Question

我正在编写文档，我想包含 pdf 文件或 zip 档案的链接。我如何使用第一种语言和 sphinx 来实现这一目标？

如果我这样做

here is a pdf file : `pdf <doc/mypdf.pdf>`_

它不起作用，因为在编译期间 sphinx 不复制 doc 目录的内容（我使用 sphinx-quickstart 生成的 makefile）。

相反，使用

image

指令：

.. image:: img/plop.png

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

Answer 1

解决方案是使用

:download:

“角色”（有关角色的 sphinx 文档中有详细介绍）。

这是一个简短的示例，假设您在目录

mypdf.pdf

中有一个文件

doc

。目录

doc

和您的第一个文件必须位于同一目录中：

here is a pdf file :download:`pdf <doc/mypdf.pdf>`

请注意，

:download:

和文件路径之间不能放置空格。

Answer 2

image

指令仅适用于带有 PDF 文件的 HTML。

.. image:: doc/mypdf.pdf

请勿使用它，因为它具有误导性。感谢 G. Milde 的评论。