Headings Cheat Sheet¶
Here are the different types of heading taken from the Sphinx documentation http://www.sphinx-doc.org/en/stable/rest.html?highlight=heading
When I read that I expected to be able to put all those on one page, and merrily went about my way doing so. When I did it created a runtime error. Or at least I thought. However, as I wrote this page, I found all playing together; ah the joys of development. Disirregardlessly [1] [, they play together as described below. Make sure to look at things like the page Table of Contents which are impacted by these hierarchies.
( = ) with over line, for Title¶
Single equal sign, under and over, the words for the Title.
===============================
( = ) with over line, for Title
===============================
( # ) with over line, for parts¶
Known today as the hash, in the united states formerly the pound sign, the text surrounded above and below is for parts.
###############################
( # ) with over line, for parts
###############################
( * ) with over line, for chapters¶
The asterik, when used over and under the text, will create a chapter in reStructuredText markup.
**********************************
( * ) with over line, for chapters
**********************************