我正在使用sphinx和RST以HTML格式生成一些技术文档,但在获取本地PDF参考作为超链接时遇到问题。我见过人们:download:
习惯于链接到本地PDF,但是我将PDF嵌入/docs
目录中以供参考。我不喜欢,:download:
因为它不会在浏览器中内联显示PDF,这需要用户采取额外的步骤才能使用。
sphinx-build -b html
除非在config.py
钩子html_static_path
或html_extra_path
-中指定了文件,否则不会复制任何文件,即使它们被放置到root
目录或_static
文件夹中也是如此。
是否有建议的方法将链接的二进制文件嵌入在狮身人面像中,或者这是一种较差的做法?通常,链接是指向未在其他任何地方托管的滑板或设计图。
.. important:: View the agile course on scrum basics
- View `these slides to dive deeper into Agile Basics <docs/agile-101.pdf>`_.
我想出的解决方案是仅将PDF添加到html_static_path
并_static
在链接中引用输出路径,而不是docs
其在源代码中的路径。现在,PDF在浏览器中打开,而无需下载即可查看。
如果有一个狮身人面像扩展名/指令来处理此(:download-inline:
),那就太好了。
html_static_path = ['_static', 'agile-101/docs']
.. important:: View the agile course on scrum basics
- View `these slides to dive deeper into Agile Basics <../_static/agile-101.pdf>`_.
本文收集自互联网,转载请注明来源。
如有侵权,请联系 [email protected] 删除。
我来说两句