python - 我可以在 Sphinx 的目录中添加水平条吗？

Question

我正在使用 Sphinx 开发文档，并希望使用水平条分隔目录中的部分。

我经常在菜单中看到这个:

有没有办法在 sphinx 中做到这一点？

Answer 1

python 狮身人面像 .. toctree::除了您在指令主体中包含的文档以及一些指令选项外，指令不允许有太多变化。

我看到其他人在这种情况下所做的是将一个 toctree 分成几个，包括它们之间的 reStructuredText。

您可以使用 toctree 的替代方法。引用文档:

Note

For local tables of contents, use the standard reST contents directive.

最简单的方法是将菜单分成几个 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

结果: