Могу ли я добавить горизонтальную полосу в оглавление в Sphinx?

Question

Я занимаюсь разработкой документации в Sphinx и хотел бы разделить разделы в оглавлении с помощью горизонтальных полос.

Я часто вижу это в меню:

Есть ли способ сделать это в сфинксе?

Answer 1

Директива python sphinx .. toctree:: не допускает большого разнообразия, кроме документов, включаемых в тело директивы, плюс несколько параметров директивы.

То, что я имею в этом случае другие делали toctree на несколько, включая reStructuredText между ними.

Вы можете использовать альтернативу toctree. Цитирование документации:

Примечание

Для локальных оглавлений используйте стандартную директиву reST content .

Самый простой способ разбить меню на несколько 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

И результат: