DOCS Cheat Sheet

Inline markup

italics Bold code

Subscripts: H₂O

Superscripts: E = mc²

Hyperlinks

Simply type the full url: http://oceanviewer.org

Use Link Text for inline web links.

Use this Search Page to link to a “pre-labeled” section (learn more)

Use this Welcome to OceanPython’s documentation! to link to an internal document.

Images

Lists

• This is a bullet
• This is another bullet
• Yet one more bullet

1. This is a numbered item
2. This is another numbered item
3. Yet one more numbered item

Sections

Section headers are created by underlining (and optionally overlining) the section title with a punctuation character, at least as long as the text:

=================
This is a heading
=================

For Python documentation, the “punctuation” convention is as follow:

• # with overline, for parts
• * with overline, for chapters
• =, for sections
• -, for subsections
• ^, for subsubsections
• ", for paragraphs

Source Code and Definitions

This is some code:

f = open('file.txt', 'r')

for line in f:
  print line, # note, coma erases the "cartridge return"

f.close()

Term 1, below is the definition

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Admonitions

This are the choices: attention, caution, danger, error, hint, important, note, tip, warning

Warning

This is a test

Hint

This is a test

Note

This is a test

Error

This is a test

Tables

Header row, column 1 (header rows optional)	Header 2	Header 3	Header 4
body row 1, column 1	column 2	column 3	column 4
body row 2	...	...

A	B	A and B
False	False	False
True	False	False
False	True	False
True	True	True