我正在编写文档,我想包含 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 存档获得相同的行为?
请您参考如下方法:
一个解决方案是使用 :download:
“角色”(在 sphinx documentation on roles 中有详细说明)。
这是一个简短的示例,假设您有一个文件 mypdf.pdf
在目录中 doc
.目录doc
并且您的 rst 文件必须在同一目录中:
here is a pdf file :download:`pdf <doc/mypdf.pdf>`
注意
:download:
之间不能有空格和文件的路径。