10

我正在使用sphinxRST将一些技术文档生成为 HTML,并且在获取本地 PDF 参考以用作超链接时遇到问题。我见过人们:download:用来链接到本地​​ PDF,但我将 PDF 嵌入到/docs目录中以供参考。我不喜欢:download:,因为它不会在浏览器中显示 PDF 内联,这需要代表用户执行额外的步骤才能使用。

sphinx-build -b html不会复制任何文件,除非它们在config.pyhookhtml_static_pathhtml_extra_path- 中指定,即使这样它们也会被拖放到root目录或_static文件夹中。

是否有建议的方法在 sphinx 中嵌入链接的二进制文件,或者这是一种不好的做法?通常,这些链接是指向不在其他任何地方托管的幻灯片或设计图表。

链接 PDF 的示例 RST

.. important:: View the agile course on scrum basics

    - View `these slides to dive deeper into Agile Basics <docs/agile-101.pdf>`_. 
4

1 回答 1

11

我想出的解决方案是将 PDF 添加到html_static_path并引用_static链接中的输出路径,而不是docs它在源中的路径。现在 PDF 在浏览器中打开,而无需下载它们来查看。

如果有一个狮身人面像扩展/指令来处理这个(:download-inline:),那就太好了。

配置文件

html_static_path = ['_static', 'agile-101/docs']

敏捷 101.rst

.. important:: View the agile course on scrum basics

- View `these slides to dive deeper into Agile Basics <../_static/agile-101.pdf>`_. 
于 2016-07-29T14:29:13.580 回答