我可以在Sphinx的目录中添加一个横条吗？

Question

我正在用Sphinx开发文档，想在目录表中使用横条来分隔部分。

我经常在菜单中看到这种情况。

有办法在Sphinx中实现吗?

Answer 1

在python的sphinx中 .. toctree:: 指令除了包含在指令体中的文件，加上一些指令选项外，不允许有太多的变化。

在这种情况下，我看到其他人的做法是将一个 toctree 变成多个，包括它们之间的重构文本。

您可以使用一个替代的 toctree. 引用文档。

注

对于本地目录，使用标准的reST 内容指令.

最简单的方法是将菜单分割成几个 toctree包括一个HTML水平尺在它们之间。

Sphinx_test
===========


.. toctree::
   :maxdepth: 4
   
   undo
   redo

.. raw:: html

   <hr>

.. toctree::
   :maxdepth: 4
   
   cut
   copy

.. raw:: html

   <hr>
   
.. toctree::
   :maxdepth: 4
      
   find
   Speech

结果是：