Что означает "несогласованный уровень заголовка"?

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

Big Title
=========

Section
-------

Subsection
~~~~~~~~~~

но ошибка связана с автогенерированным текстом (automodapi), который я не могу отслеживать:

Classes
^^^^^^^

Как я могу выяснить, откуда происходит "несогласованность"?

Ответы

Ответ 1

Очевидно, ответ был очевиден: http://sphinx-doc.org/rest.html#sections

# with overline, for parts
* with overline, for chapters
=, for sections
-, for subsections
^, for subsubsections
", for paragraphs

Я использовал ==== как заголовок верхнего уровня, потому что это riv.vim, но #### и **** находятся над ними. ~~~~~, по-видимому, даже не является официальным.

Я все еще не совсем понимаю проблему, так как я использовал ---- над местоположениями, которые номинально использовали ^^^^, что должно быть хорошо, но нагнетание всех заголовков на один уровень решило мою конкретную проблему.

Ответ 2

Я получил ту же ошибку, о которой вы сообщили. Мне кажется, что это было вызвано смешением ^ и ~ для подсекций. Подставляя один для другого во весь документ, ошибка исчезла.

Ответ 3

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

Например, убедитесь, что ваши разделы (=), подразделы (-) и подразделы (~) последовательно используют один и тот же символ подчеркивания во всем документе, и что вы не используете разные символы подчеркивания для тот же уровень заголовка случайно.