将下载链接添加到toctree

Question

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

理想情况下，它应该是这样的：

• Foo Example

- **download foo.py file**
- **download foo.ipynb file**

• Bar Example

- **download bar.py file**
- **download bar.ipynb file**

我试过：

.. 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

• download foo.py file

• download foo.ipynb file

• Bar Example

• download bar.py file

• download bar.ipynb file

这看起来不太好，而且我的实际toctree中还有更多的文档。有什么办法可以做到这一点吗？

Answer 1

下载不是reStructuredText文档，也不能是树中的条目。

相反，你有两个解决办法。

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

。。图克树：：https://helloworld.com/src/helloworld.py

1. 创建一个中间.rst文档，其中包含下载的链接，并将该文档放在您的toctree.

中。