【发布时间】:2014-08-21 15:52:23
【问题描述】:
我在我的文档版本中收到了各种“标题级别不一致”的警告。据我所知,我有一个一致的结构,看起来像:
Big Title
=========
Section
-------
Subsection
~~~~~~~~~~
但该错误与我无法追踪的自动生成 (automodapi) 文本有关:
Classes
^^^^^^^
我怎样才能找出“不一致”的来源?
【问题讨论】:
标签: python-sphinx
我在我的文档版本中收到了各种“标题级别不一致”的警告。据我所知,我有一个一致的结构,看起来像:
Big Title
=========
Section
-------
Subsection
~~~~~~~~~~
但该错误与我无法追踪的自动生成 (automodapi) 文本有关:
Classes
^^^^^^^
我怎样才能找出“不一致”的来源?
【问题讨论】:
标签: python-sphinx
显然答案很明显: 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 所做的,但#### 和**** 在它们之上。 ~~~~~ 显然不是官方的。
我仍然没有完全理解这个问题,因为我在名义上使用^^^^ 的位置上方使用了----,这应该没问题,但是将所有标题提升一个级别已经解决了我的特定问题。
【讨论】:
我也遇到了同样的麻烦,在我看来,你不应该在你的层次结构中做一个漏洞。 html 和 Markdown 可以使用任何你想要的标题,但首先你必须使用所有级别。
我的意思是你可以做到
h1 h2 h3 h4
或
h2 h3
但您不能执行以下操作
h1 h2 h4
【讨论】:
我确实收到了与您报告的相同的错误。对我来说,这似乎是由混合 ^ 和 ~ 为小节引起的。通过在整个文档中替换另一个,错误消失了。
【讨论】:
检查整个文档并确保您始终使用相同的字符来表示每个层次结构级别。
例如,确保您的部分 (=)、子部分 (-) 和子部分 (~) 在整个文档中始终使用相同的下划线字符,并且您没有使用不同的下划线同一标题级别的字符是偶然的。
【讨论】: