如何使用sphinx创建一个链接来下载rst中的目录？

Question

我们可以将其添加到 rst 以创建指向文件的链接

:download:`Name <doc/name.pdf>`

。

可以是整个目录吗？

:download:`Dir <doc/>`

不起作用。

是否应该始终预先存档？

Answer 1

目录不是文件。

download

角色：

...允许您链接到源树中的文件...可以下载。

您必须将您想要下载的任何内容设为可下载。在构建文档之前，您需要对目录中的文件进行 tar、zip 或其他任何操作。

Answer 2

使用

sphinx-btn

：

$ pip install sphinx-btn

extensions = [
    …
    'sphinxcontrib.icon',
    'sphinxcontrib.btn',
]

I'm a :btn:`<fa-solid fa-folder> fa-folder` btn.

我是📁 fa-folder btn。