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

kef*_*ich 16 python-sphinx

在我的文档版本中,我一直收到警告"标题级别不一致".据我所知,我有一个一致的结构,看起来像:

Big Title
=========

Section
-------

Subsection
~~~~~~~~~~
Run Code Online (Sandbox Code Playgroud)

但该错误与automodapi我无法追踪的autogenerated()文本相关联:

Classes
^^^^^^^
Run Code Online (Sandbox Code Playgroud)

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

kef*_*ich 25

显然答案显而易见:http: //sphinx-doc.org/rest.html#sections

# with overline, for parts
* with overline, for chapters
=, for sections
-, for subsections
^, for subsubsections
", for paragraphs
Run Code Online (Sandbox Code Playgroud)

我一直在使用====我的顶级标题,因为这是riv.vim所做的,但是####并且****高于它们. ~~~~~显然甚至不是官方的.

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

  • 还要注意 `.. include:: externalfile.txt` 指令 - 该子文档中的装饰层次结构也必须与父文档一致 (2认同)