2 Basic Formatting§

2.1 Paragraphs§

https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#paragraphs

Lorem ipsum dolor sit amet, consectetur adipiscing 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.

Curabitur pretium tincidunt lacus. Nulla gravida orci a odio. Nullam varius, turpis et commodo pharetra, est eros bibendum elit, nec luctus magna felis sollicitudin mauris. Integer in mauris eu nibh euismod gravida. Duis ac tellus et risus vulputate vehicula. Donec lobortis risus a elit. Etiam tempor. Ut ullamcorper, ligula eu tempor congue, eros est euismod turpis, id tincidunt sapien risus a quam. Maecenas fermentum consequat mi. Donec fermentum. Pellentesque malesuada nulla a mi. Duis sapien sem, aliquet nec, commodo eget, consequat quis, neque. Aliquam faucibus, elit ut dictum aliquet, felis nisl adipiscing sapien, sed malesuada diam lacus eget erat. Cras mollis scelerisque nunc. Nullam arcu. Aliquam consequat. Curabitur augue lorem, dapibus quis, laoreet et, pretium ac, nisi. Aenean magna nisl, mollis quis, molestie eu, feugiat in, orci. In hac habitasse platea dictumst.


After the line.

2.2 Compound Paragraphs§

https://docutils.sourceforge.io/docs/ref/rst/directives.html#compound-paragraph

The code

print('Hello, world!')

will show a message.

Compound paragraph in admonition

The code

print('Hello, world!')

will show a message.

Compound paragraph in topic

The code

print('Hello, world!')

will show a message.

2.4 Inline Markup§

https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#inline-markup

Normal Inline Literal Emphasis Strong Emphasis.

2.6 Footnotes§

https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#footnotes

https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#footnotes

Footnote 1 and *. And some more: 2, 2, 2, 2.

1

This is an auto-numbered footnote. There is a lot of additional text, so there will be a line break and we will see how the second line is indented.

Auto-numbered, multiple mentions.

*

This is an auto-symbol footnote.

Admonition title with footnote 3

Footnote in admonition text.

This is probably not used very often.

3

This probably even less.

Warning

Footnote in warning text.

See above.

See also

Footnote § in seealso text.

§

See above.

Topic title with footnote 4

Footnote in topic text.

See above.

4

See above.

2.7 Citations§

https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#citations

https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#citations

Here is a citation reference: The Title [CIT2002]. And another citation reference: [CIT2020]. Another mention of the same citation: [CIT2020].

CIT2002

This is the citation. It’s just like a footnote, except the label is textual.

CIT2020(1,2)

A literature reference with multiple back-links. There is a lot of description text here, which will probably lead to a line break.

2.8 Other Semantic Markup§

https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#other-semantic-markup

abbr: LIFO – command: rm – dfn: term – file: name.ext – guilabel: Cancel – kbd: Control + x Control + f – mailheader: Content-Type – makevar: AM_CFLAGS – manpage: ls(1), man – menuselection: Start ‣ Programs – mimetype: text/plain – newsgroup: comp.lang.python – program: rm – regexp: a* – samp: print(1+variable) (as compared to print(1)) – pep: PEP 8 – rfc: RFC 2822