Поместите второстепенные страницы в нужное место в оглавлении

В моей документации sphinx есть несколько второстепенных страниц, которые (конечно) должны быть частью toctree, но я не могу перечислить их в нужном месте.

Если моя страница «раздела 3» выглядит так:

.. toctree::
   3.3
   3.4

3
=====



3.1
-----


3.2
---

Затем 3.3 и 3.4 перечислены перед 3.

Я пробовал другие перестановки, но ни одна из них не работает.

  1. Если я помещу toctree после заголовка 3, тогда 3.3 и 3.4 будут перечислены между 3 и 3.1.
  2. Если я поставлю toctree в конец страницы, все будет в правильном порядке, но 3.3 и 3.4 станут разделами третьего уровня, дочерними для раздела 3.2.

Я привел конкретный пример, здесь:


sections python-sphinx read-the-docs toctree
person bukzor    schedule 26.02.2016    source источник

Ответы (1)


arrow_upward
0
arrow_downward

Чтобы получить правильную общую структуру, вы можете использовать директиву включения. следующим образом:

3
=====

3.1
-----

3.2
---

.. include:: 3_3.rst

.. include:: 3_4.rst

Тем не менее, нет хорошего способа разместить эти разделы в toctree на одной странице. Перечисление self в toctree покажет только заголовок первого уровня, а прямая ссылка на себя - в вашем примере на further-detail-1 - будет работать для html (хотя это вызовет предупреждение), но испортит сборку latexpdf.

В качестве обходного пути вы можете просто жестко закодировать собственное toctree, используя список ссылки.

person Timotheus.Kampik    schedule 27.02.2016