Skip to content

Latest commit

 

History

History
202 lines (130 loc) · 5.51 KB

basic-formatting.rst

File metadata and controls

202 lines (130 loc) · 5.51 KB
Raw

Basic Formatting

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.

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.

Line Blocks

https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#line-blocks

Manual
line breaks.

Inline Markup

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

Normal Inline Literal Emphasis Strong Emphasis.

Multiple spaces are not collapsed in inline literals: a b c. very/long/literals/are/broken/without/inserting/a/hyphen. averyveryveryverylongsinglewordisalsoforciblybrokenatsomepointwithoutinsertingahyphen.

Hyperlinks

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

Internal link, external link.

Other page: code-blocks.

Some file: insipid.png.

Math equation: euler.

Footnotes

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

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

Footnote1 and2. And some more: 3, 4, 5, 6.

Admonition <admonitions> title with footnote

Footnote in admonition text.

Warning

Footnote in warning text.

Footnote in seealso text.

Topic title with footnote

Footnote in topic text.

Sidebar title with footnote

Footnote in sidebar text.

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].

Other Semantic Markup

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

abbr: LIFO (last-in, first-out) --command: rm --dfn: term --file: name.{ext} --guilabel: &Cancel --kbd (separate): Control + x Control + f --kbd (combined, needs Sphinx >= 3.5.0): 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: 8 --rfc: 2822

CIT2002

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

CIT2020

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

  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.↩

  2. This is an auto-symbol footnote.↩

  3. Auto-numbered, multiple mentions.↩

  4. Auto-numbered, multiple mentions.↩

  5. Auto-numbered, multiple mentions.↩

  6. Auto-numbered, multiple mentions.↩