У меня возникла проблема в структурировании моего руководства для пользователей Sphinx. Я хотел бы создать главу, имея главную целевую страницу (index.rst), которая содержит заголовок раздела и обзор, а затем отдельные подразделы, содержащиеся в разных файлах (part1.rst, part2.rst). Я пытаюсь использовать "toctree", чтобы вставлять отдельные подразделы, но я столкнулся с проблемой вложенности, в которой мой toctree всасывается в мой раздел обзора. (примечание: я не использую директиву ..include::, потому что я хочу, чтобы разделы, отображаемые на разных веб-страницах, последовательно связаны друг с другом. Я также хочу, чтобы структурированные правильно, чтобы они хорошо отображались в pdf-версии версии UG).
index.rst
Chapter 3 =============================== Overview -------- Yadda yadda yadda. .. toctree:: :hidden: part1 part2
part1.rst
Part 1 ------ This part is all about yadda.
part2.rst
Part 2 ------ More yadda.
Я хотел бы, чтобы результирующая структура была:
Chapter 3 - overview - part 1 - part 2
Но я получаю
Chapter 3 - overview - part 1 - part 2
Похоже, что теток, который я включаю в нижней части файла, попадает под раздел "Обзор", а не запускается в контексте основной главы. Я попытался вставить указатель в верхней части файла, но затем я получаю этот порядок:
Chapter 3 - part 1 - part 2 - overview
Кажется, должен быть способ сделать это правильно, но я не смог найти что-либо на сайте Sphinx или здесь, на SO. Любая помощь приветствуется.
У меня была точно такая же проблема, и я не мог найти хорошего решения. Единственные варианты, казалось, либо удалили подзаголовок ( "Обзор" в примере выше), либо отметили его как рубрику, например.
.. rubric:: Overview
что означает, что он не входит в TOC. Должна быть возможность применить стиль к рубрике, чтобы она выглядела как подзаголовок, но делать это так, похоже, немного взломать.