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

时间:2013-01-15 20:05:22

标签: python-sphinx restructuredtext

我正在撰写文档,我想包含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存档的相同行为?

2 个答案:

答案 0 :(得分:44)

我在sphinx documentation找到了解决方案。

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

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

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

答案 1 :(得分:0)

The image directive also works for PDF files.

.. image:: doc/mypdf.pdf