将下载链接添加到 toctree

Question

我想在我的目录树中添加一个带项目符号的下载链接列表。

理想情况下，它看起来像这样：

• Foo Example

  • 下载 foo.py 文件
  • 下载 foo.ipynb 文件

• Bar Example

  • 下载 bar.py 文件
  • 下载 bar.ipynb 文件

我试过了：

.. toctree::

   foo
   * :download:`download foo.py file <files/foo.py>`
   * :download:`download foo.ipynb file <files/foo.ipynb>`
   bar
   * :download:`download bar.py file <files/bar.py>`
   * :download:`download bar.ipynb file <files/bar.ipynb>`

但这失败了，因为toctree 只希望引用文档：

WARNING: toctree contains reference to nonexisting document '* :download:`download foo.py file <files/foo.py>`'

我最接近的是：

.. toctree::

   foo
   
* :download:`download foo.py file <files/foo.py>`
* :download:`download foo.ipynb file <files/foo.ipynb>`

.. toctree::

   bar

* :download:`download bar.py file <files/bar.py>`
* :download:`download bar.ipynb file <files/bar.ipynb>`

看起来像这样：

• Foo Example

• 下载 foo.py 文件

• 下载 foo.ipynb 文件

• Bar Example

• 下载 bar.py 文件

• 下载 bar.ipynb 文件

这看起来不太好，我的实际toctree 中有更多文档。有没有办法做到这一点？

Answer 1

下载不是 reStructuredText 文档，并且不能是目录树中的条目。

相反，您有两种解决方法。

1. 使用完全限定的 HTTP URL 进行下载。

   .. toctree::
   
       https://helloworld.com/src/helloworld.py
   

2. 创建一个包含下载链接的中间.rst 文档，并将该文档放入您的目录树中。