python-sphinx - 如何更改通过下载角色引用的文件的文件路径以不使用散列文件夹？

Question

我想提供一个指向我的项目中的文件的链接，但我希望该链接是人类可读且永久的。

这样做:

Link to file for reference :download:`myfile.json <../myproject/myfile.json>`.

生成一个如下所示的链接:

...../myproject/docs/_build/html/_downloads/b4c73f3851c188db23a20daeed2c/myfile.json

我可以控制这个吗？我希望链接是这样的:

...../myproject/docs/_build/html/_downloads/myfile.json

我实际上希望链接位于根目录中，因此它只是:

...../myproject/myfile.json

Answer 1

download role执行文档中所述的操作，即，它创建具有唯一哈希的链接。除非改变实现，否则我看不到解决办法。

但是

I would actually prefer the link be in the root

在这种特殊情况下，我们可以(ab)使用 html_extra_path ，将其添加到 conf.py

html_extra_path = ['../myproject/myfile.json']

并使用常规 hyperlink 引用该文件:

Link to file for reference `myfile.json <myfile.json>`_.

该文件必须位于(构建的 HTML 文档的)根文件夹中，因为这就是 html_extra_path 的作用。它不能放在子文件夹中，例如 _downloads。