47

我正在编写文档,我想包含指向 pdf 文件或 zip 档案的链接。如何使用 rst 语言和 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 存档获得相同的行为?

4

2 回答 2

69

一个解决方案是使用:download:“角色”(在sphinx 关于角色的文档中有详细说明)。

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

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

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

于 2013-01-15T20:32:01.490 回答
0

The image directive also works for PDF files.

.. image:: doc/mypdf.pdf
于 2018-08-24T15:11:18.643 回答