reStructuredText Styling Examples

Titles

=, for sections

-, for subsections

^, for subsubsections

“, for paragraphs

Bold, Italic

This is normal text. This is bold text

This is normal text. This is italic text.

Footnote

Lorem ipsum dolor sit amet, est ne exerci vivendum accusata, nec molestiae scripserit eloquentiam in, quodsi moderatius argumentum est ad. Autonumbered footnotes are possible, like using 1 and 2.

1

This is the first one.

2

This is the second one.

Table

Inputs

Output

A

B

A or B

False

False

True

False

True

False

True

True

True

True

Note and Warning Boxes

Note

Lorem ipsum dolor sit amet, est ne exerci vivendum accusata, nec molestiae scripserit eloquentiam in, quodsi moderatius argumentum est ad. Aliquam denique nam in. Malorum percipit sed cu. Ut est vide suscipit, an nonumy alterum liberavisse his. Mazim fastidii vim et, vim id noster instructior. At audiam bonorum vim, te tantas facete vel.

Warning

Lorem ipsum dolor sit amet, est ne exerci vivendum accusata, nec molestiae scripserit eloquentiam in, quodsi moderatius argumentum est ad. Aliquam denique nam in. Malorum percipit sed cu. Ut est vide suscipit, an nonumy alterum liberavisse his. Mazim fastidii vim et, vim id noster instructior. At audiam bonorum vim, te tantas facete vel.

Inline Code

Lorem ipsum dolor sit amet, /etc/passwd est ne exerci vivendum accusata, result = (1 + x) * 32 nec molestiae scripserit eloquentiam in, quodsi moderatius press Ctrl + S argumentum est ad.

Code Block

# Console
sudo apt-get update

# Python
print('Hello, world!')

// C++
#include <iostream>
using namespace std;

int main() {
    // prints the string enclosed in double quotes
    cout << "This is C++ Programming";
    return 0;
}

Un-selectable Prompt

sudo apt-get update
sudo apt install build-essential
sudo apt-get install manpages-dev
gcc --version

Image and Figure

../../_images/baby_hawk.png

This is the caption of the figure with link to http://google.com

../../_images/baby_hawk.png

Image in a table

Image

Content
../../_images/baby_hawk.png

Baby Hawk 1
../../_images/baby_hawk.png

Baby Hawk 2

Inline image

Lorem ipsum dolor babyhawk sit amet, est ne exerci vivendum accusata, babyhawk molestiae scripserit eloquentiam in

List

This is a bullet list:

  • list item 1

  • list item 2

More text. Important: Always add blank line before and after list!

This is a bullet list:

  • list item 1

    • list item 1.1

    • list item 1.2

  • list item 2

Numbered List

some text

  1. list item 1

  2. list item 2

some text

Field List

Authors

Tony J. (Tibs) Ibbs, David Goodger (and sundry other good-natured folks)

Version

1.0 of 2001/08/08

Dedication

To my father.

0

True

1

False

Math Formula

(1)\[a^2 + b^2 = c^2\]
(2)\[\begin{split} x^2 & : x < 0 \\ x^3 & : x \ge 0 \\\end{split}\]
\[n_{\mathrm{offset}} = \sum_{k=0}^{N-1} s_k n_k\]

UML Diagrams

../../_images/5c5ffbf8b009230e6c80e4650d912e09fb3e3b0bba8711338861ac94db35bac7.svg../../_images/b9aed2e88014b76db6f53d3f40e70db8106f3cf902b8114b678066c89cb3a700.svg

Cross-referencing

Go to first title of this page or learn how to install Sphinx or learn how to install Sphinx