page 1 Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
page 2 Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Lorem ipsum dolor sit amet, consectetur adipisicing elit …
*italic*
=> italic**bold**
=> bold`python<www.python.org>`_
=> python``verbatim``
=> verbatim
- Child1
This is a simple example:
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.
Danger
This is sample of admonition directive for “Danger”. Lorem ipsum dolor sit amet, consectetur adipisicing elit … Lorem ipsum dolor sit amet, consectetur adipisicing elit …
Error
This is sample of admonition directive for “Error”. Lorem ipsum dolor sit amet, consectetur adipisicing elit … Lorem ipsum dolor sit amet, consectetur adipisicing elit …
Warning
This is sample of admonition directive for “Warning”. Lorem ipsum dolor sit amet, consectetur adipisicing elit … Lorem ipsum dolor sit amet, consectetur adipisicing elit …
Caution
This is sample of admonition directive for “Caution”. Lorem ipsum dolor sit amet, consectetur adipisicing elit … Lorem ipsum dolor sit amet, consectetur adipisicing elit …
Attention
This is sample of admonition directive for “Attention”. Lorem ipsum dolor sit amet, consectetur adipisicing elit … Lorem ipsum dolor sit amet, consectetur adipisicing elit …
Important
This is sample of admonition directive for “Important”. Lorem ipsum dolor sit amet, consectetur adipisicing elit … Lorem ipsum dolor sit amet, consectetur adipisicing elit …
Note
This is sample of admonition directive for “Note”. Lorem ipsum dolor sit amet, consectetur adipisicing elit … Lorem ipsum dolor sit amet, consectetur adipisicing elit …
Hint
This is sample of admonition directive for “Hint”. Lorem ipsum dolor sit amet, consectetur adipisicing elit … Lorem ipsum dolor sit amet, consectetur adipisicing elit …
Tip
This is sample of admonition directive for “Tip”.
See also
This is sample of admonition directive for “SeeAlso”.
New in version 0.3.1: Here is description of specification which added on that version.
Changed in version 0.8: Here is description of specification which changed on that version.
Deprecated since version 0.8: Here is description of specification which changed on that version.
1 2 3 | >>> from fibo import fib, fib2
>>> fib(500)
1 1 2 3 5 8 13 21 34 55 89 144 233 377
|
Todo
TODO directive.
I have footnoted a first item [1] and second item [2]. Lorem ipsum dolor sit amet [3] , consectetur adipisicing elit …
[1] | My first footnote. My first footnote.My first footnote.My first footnote.My first footnote.My first footnote. |
[2] | My second footnote. |
[3] | A footnote contains body elements, consistently indented by at least 3 spaces. |
Citation references, like [CIT2002]. Note that citations may get rearranged, e.g., to the bottom of the “page”.
Citation labels contain alphanumerics, underlines, hyphens and fullstops. Case is not significant.
Given a citation like [this], one can also refer to it like this.
[CIT2002] | A citation (as often used in journals). |
[this] | here. |
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 bullet list
Item 2.
Paragraph 2 of item 2.
Definition paragraph 1.
Definition paragraph 2.
what: | Field lists map field names to field bodies, like database records. They are often part of an extension syntax. They are an unambiguous variant of RFC 2822 fields. |
---|---|
how arg1 arg2: | The field marker is a colon, the field name, and a colon. The field body may contain one or more body elements, indented relative to the field marker. |
-a | command-line option “a” |
-b file | options can have arguments and long descriptions |
--long | options can be long also |
--input=file | long options can also have arguments |
--very-long-option | |
The description can also start on the next line. The description may contain multiple body elements, regardless of where it starts. |
-x, -y, -z | Multiple options are an “option group”. |
-v, --verbose | Commonly-seen: short & long options. |
-1 file, --one=file, --two file | |
Multiple options with arguments. | |
/V | DOS/VMS-style options too |
Literal blocks are indicated with a double-colon (“::”) at the end of
the preceding paragraph (over there -->
). They can be indented:
if literal_block:
text = 'is left as-is'
spaces_and_linebreaks = 'are preserved'
markup_processing = None
Or they can be quoted without indentation:
>> Great idea!
>
> Why didn't I think of that?
Take it away, Eric the Orchestra Leader!
A one, two, a one two three fourHalf a bee, philosophically,must, ipso facto, half not be.But half the bee has got to be,vis a vis its entity. D’you see?But can a bee be said to beor not to be an entire bee,when half the bee is not a bee,due to some ancient injury?Singing…
Block quotes consist of indented body elements:
My theory by A. Elk. Brackets Miss, brackets. This theory goes as follows and begins now. All brontosauruses are thin at one end, much much thicker in the middle and then thin again at the far end. That is my theory, it is mine, and belongs to me and I own it, and what it is too.
—Anne Elk (Miss)
>>> print 'Python-specific usage examples; begun with ">>>"'
Python-specific usage examples; begun with ">>>"
>>> print '(cut and pasted from interactive Python sessions)'
(cut and pasted from interactive Python sessions)
Topic Title
This is a topic. 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.
New in version 2.5: The spam parameter.
Changed in version 2.5: The spam parameter.
Deprecated since version 2.5: The spam parameter.
Footnotes
LICENSE AGREEMENT
|
|
|
This paragraph contains a literal block:
Connecting... OK
Transmitting data... OK
Disconnecting... OK
and thus consists of a simple paragraph, a literal block, and another simple paragraph. Nonetheless it is semantically one paragraph.
This construct is called a compound paragraph and can be produced with the “compound” directive.
try_stmt ::= try1_stmt | try2_stmt try1_stmt ::= "try" ":"suite
("except" [expression
[","target
]] ":"suite
)+ ["else" ":"suite
] ["finally" ":"suite
] try2_stmt ::= "try" ":"suite
"finally" ":"suite