什么"标题级别不一致"意思?

时间:2014-07-01 07:05:17

标签: python-sphinx

我的文档版本中已经收到警告“标题级别不一致”。据我所知,我有一个看似如下的结构:

Big Title
=========

Section
-------

Subsection
~~~~~~~~~~

但该错误与我无法追踪的自动生成(automodapi)文字相关联:

Classes
^^^^^^^

我怎样才能找出“不一致”的来源?

4 个答案:

答案 0 :(得分:20)

显然答案显而易见: 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的作用,但####****在它们之上。 ~~~~~显然不是正式的。

我仍然没有完全理解这个问题,因为我在名义上使用----的位置上方^^^^使用{{1}},这应该没问题,但是将所有标题提升到一个级别解决了我的特殊问题。

答案 1 :(得分:1)

我遇到了同样的问题,在我看来你不应该在你的层次结构中做一个漏洞。 html 和 Markdown 可以使用您想要的任何标题,但首先您必须使用所有级别。

我的意思是你可以做到

h1 小时2 H3 h4

h2 h3

但是您不能执行以下操作

h1 小时2 h4

答案 2 :(得分:0)

我确实得到了您报告的相同错误。对我来说,它似乎是由于子和小节混合^和〜造成的。通过在整个文档中用一个替换另一个,错误消失了。

答案 3 :(得分:0)

检查整个文档,并确保您始终使用相同的字符表示层次结构的每个级别。

例如,确保您的节(=,子节(-)和子节(~)在整个文档中始终使用相同的下划线字符,并且在相同的标题级别上不会偶然使用不同的下划线字符。