Sphinx latex Оглавление - избегайте вложенности первых трех файлов - PullRequest
Новая
       22

Sphinx latex Оглавление - избегайте вложенности первых трех файлов

0 голосов
/ 16 апреля 2020

У меня есть документация sphinx со следующей структурой: 

My chapter title
=====================

Chapter intro part 1
--------------------------
Brief introduction that I would like to have in the start of this chapter...

Chapter intro part 2
--------------------------
Another short section ...


.. toctree::
   :hidden:
   :maxdepth: 2

   folder/subchapter1
   folder/subchapter2

Когда я рендерим html, основываясь на этом, все работает как задумано - у меня есть стартовая страница для этой главы и моих подглав доступны из бокового меню.

Однако, когда я создаю свой вывод из латекса / PDF, иерархия структурируется следующим образом в оглавлении и нумерации: 

0.2 My chapter title
- 0.2.1 Chapter intro part 1
- 0.2.2 Chapter intro part 2
  - 0.2.2.1 subchapter1
  - 0.2.2.2 subchapter2

То, что я хотел получить, было ниже: 

0.2 My chapter title
- 0.2.1 Chapter intro part 1
- 0.2.2 Chapter intro part 2
- 0.2.3 subchapter1 title
- 0.2.3 subchapter2 title

Или альтернативно: 

0.2 My chapter title
0.2.1 subchapter1 title
0.2.2 subchapter2 title

Я понимаю, что это, вероятно, попытка немного "взломать" концепцию toctree, но я пытаюсь удовлетворить оба требования иерархии для html и латекс с одинаковым кодом.

Я использую Sphinx 1.8.5 и настройки по умолчанию для латекса.

1 Ответ

0 голосов
/ 22 апреля 2020

Я использовал следующую структуру: 

Hardware
=============================

.. only:: html

  .. include:: hardware/intro.rst


.. toctree::
   :hidden:
   :maxdepth: 2

   hardware/intro
   hardware/installation
   hardware/connector

В conf.py я добавил: 

if tags.has("output_html"):
    exclude_patterns.append("*/intro.rst")

И в процессе сборки я добавляю тег output_html так как стандартный тег html недоступен в conf.py. С этим я получил то, что хотел.

...