Notes, comments and side bars

Any text using the style marked by the notestyle option will be checked for the following initial words:

Start

Meaning

Comment:

will create a Sphinx Comment

Contents:

will include a Contents tree for the current page (example below)

Hidden:

will hide the following text

NextHere:

is a place marker for where the following notestyle is to be placed

Note:

will create a Sphinx Note (example below)

Sidebar:

will create a Sphinx Sidebar, with the title as following the word ‘Sidebar:’ (example right)

Topic:

will create a Sphinx Topic, with the title as following the word ‘Topic:’
which uses the title following the word Topic

Class:(style)

will format the following paragraph with the named style.

End:

will end the previous notestyle (usually this is not needed, but where (eg) Class: is used, this will end the scope of the class.

Note

A Sidebar will cause a break in the text, so should be placed at a natural break in the text rather than just anywhere.

Note

Sidebars and Notes can overlap.

To end a Note and continue with regular text, use the NoteStyle containing End: