Предотвращение повторного запуска сфинксом нумерации разделов каждого файла - PullRequest
0 голосов
/ 04 октября 2018

Мой индексный файл настроен так:

Doc Title
==============================

..toctree::
   :maxdepth: 3
   :numbered:
   :caption: Contents

   01_file1
   01.3_file2

Если содержимое таким образом ...

01_file1.txt:

Level 1 section title
--------------------------------------------

Level 2 section title
............................................

Another Level 2 section title
............................................

и для 01.3_file2.txt:

A third Level 2 section title
............................................

Я ожидал бы этого, потому что Sphinx рассматривает все как один документ:

1. Level 1 section title
  1.1 Level 2 section title
  1.2 Another Level 2 section title
  1.3 A third Level 2 section title

Но вместо этого я получаю это:

1. Level 1 section title
  1.1 Level 2 section title
  1.2 Another Level 2 section title
2. A third Level 2 section title

Я предполагаю, что это потому, что Sphinx (или, может быть, reST / Markdown?) Перезапускает неявные уровни заголовков с каждым новым текстовым файлом.Есть ли способ получить то, что я на самом деле хочу?

Цитирование reST документации ...

Вместо того, чтобы вводить фиксированное число и порядок заголовка разделастили оформления, порядок применения будет соответствовать порядку.Первый встреченный стиль будет самым внешним заголовком (например, HTML H1), второй стиль будет субтитром, третий будет субтитром и т. Д.

1 Ответ

0 голосов
/ 04 октября 2018

Родительский файл определяет уровень заголовка включенных в него дочерних элементов.Чтобы достичь желаемого эффекта, удалите 01.3_file2 из index и поместите .. include:: 01.3_file2 в 01_file1.txt в точку, где вы хотите его включить.


index:

Doc Title
==============================

..toctree::
   :maxdepth: 3
   :numbered:
   :caption: Contents

   01_file1

01_file1.txt:

Level 1 section title
--------------------------------------------

Level 2 section title
............................................

Another Level 2 section title
............................................

.. include:: 01.3_file2.txt

01.3_file2.txt:

A third Level 2 section title
............................................

Результат:

1. Level 1 section title
  1.1 Level 2 section title
  1.2 Another Level 2 section title
  1.3 A third Level 2 section title
...