Was this page helpful?
While Sphinx supports many layers of headings, at ScyllaDB we try to keep the hierarchy limited to 4, excluding the title. If you have the need for a H4, chances are that you need to re-arrange the content. Watch the length of your text vs the markup. It must be at least as long as the text. It can be longer, but shorter will produce an error. Also, if your markup has a line above and below both lines must be the same length.
Use the following convention for headings:
Heading |
Markup |
Description |
|---|---|---|
Page Title |
=========
Title
=========
|
Has an equal sign above and below the text. Use for the title of the page. It should be used only once per page |
H1 |
Heading 1
---------
|
Has a dash below the text. Use for the first level heading. |
H2 |
Heading 2
=========
|
Has an equal sign below the text. Use for the second level heading. |
H3 |
Heading 3
.........
|
Has dots below the text. Use for a third level heading. |
H4 |
Heading 4
^^^^^^^^^
|
Has carats below the text. Use for a fourth level heading. If you need more levels, re-arrange the text. |
Was this page helpful?