我在我的文档版本中收到了各种“标题级别不一致”的警告。 据我所知,我有一个一致的结构,看起来像:
Big Title
=========
Section
-------
Subsection
~~~~~~~~~~
但是该错误与我无法追踪的自动生成的(
automodapi
)文本相关:
Classes
^^^^^^^
如何找出“不一致”从何而来?
显然答案很明显: https://www.sphinx-doc.org/en/master/usage/restructedtext/basics.html#sections
# with overline, for parts
* with overline, for chapters
=, for sections
-, for subsections
^, for subsubsections
", for paragraphs
我一直使用
====
作为我的顶级标题,因为这就是 riv.vim 的作用,但 ####
和 ****
位于它们之上。 ~~~~~
显然甚至不是官方的。
我仍然不完全理解这个问题,因为我在名义上使用
----
的位置上方使用了^^^^
,这应该没问题,但是将所有标题向上提升一级已经解决了我的特定问题。
我也遇到了同样的麻烦,在我看来,你不应该在你的层次结构中留下漏洞。 html 和 Markdown 可以使用任何你想要的标题,但首先你必须使用所有级别。
我的意思是你可以做
h1 小时2 小时3 h4
或
h2 h3
但你不能执行以下操作
h1 小时2 h4
我确实遇到了与您报告的相同的错误。对我来说,这似乎是由混合 ^ 和 ~ 作为小节引起的。通过在整个文档中替换另一个,错误消失了。
检查整个文档并确保始终使用相同的字符来表示每个层次结构级别。
例如,确保您的章节 (
=
)、小节 (-
) 和子小节 (~
) 在整个文档中一致使用相同的下划线字符,并且您没有使用不同的下划线字符意外地相同的标题级别。
对我来说,是这样的:
==
h1
==
...
h3
--
...
h2
==
...
我必须提高
h3
才能使用=
而不是-
。