在Python sphinx中,如何链接到_static目录中的文件

Question

我有一些代码和数据样本我复制到_static目录,我想链接到文档中的那些文件,如:

.. _pca-run.py: _static/example.data

但问题是sphinx没有为这个文件创建一个合适的相对链接,只是按原样复制值.因此,对于_static不在同一目录中的嵌套文件,链接不起作用.

Answer 1

你想要的是:download:文字角色.(正如米塔尔在评论中提到的那样).

使用它将告诉Sphinx将给定文件复制到"_downloads"目录并创建一个指向它的超链接.这最初打算用于可下载的文件,例如PDF(在html输出中)或tarball,或者其他什么.它适用于任何其他非ReST文件.

如果你真的想要,你可以写一个扩展来做这件事,但我从来没有看到过需要,因为:download:我的确需要.

Answer 2

只需为图像找到正确的答案:预先渲染目标文件的路径/.对于从中引用的图像automodule

.. image:: some_file.png

将引用some_file.png相对于当前正在处理的python文件的文件

.. image:: /some_file.png

将引用some_file.png相对于该位置的文件conf.py.这样,就不需要用图像污染源层次结构.