ReStructuredText Cheat Sheet¶
BeagleBoard docs is mostly writted with ReStructuredText (r)
Headings¶
For each document we divide sections with headings and in ReStructuredText we can use matching overline and underline to indicate a heading.
Document heading (H1) use
#
.First heading (H2) use
*
.First heading (H2) use
=
.First heading (H2) use
-
.First heading (H2) use
~
.
Note
You can include only one (H1) #
in a single documentation page.
Make sure the length of your heading symbol is atleast (or more) the lenth of the heading text, for example: