Contents

• Tips

  • Text formatting

    • Headings

    • Lists

    • Links

      • External links

      • Internal Links (Cross-referencing)

    • Tables

    • Images

    • Maths

    • Terms

    • Blocks

      • Literal Block

      • Doctest blocks

    • Raw HTML

  • Structure

    • TOC Tree

    • Include text

    • Meta data

    • Tags

  • Configuration

Tips

Text formatting

Headings

• # with overline, for parts

• * with overline, for chapters

• = for sections

• - for subsections

• ^ for subsubsections

• “ for paragraphs

Lists

Hlist

first item second item

3d item 4th item

5th item

Links

External links

This is a paragraph that contains a link to Google.

Internal Links (Cross-referencing)

reference-guide

Tables

Simple table

Column A	Column B	Column C
row 1A	row 1B	row 1C
row 2A	row 2B	row 2C

Grid table

Column A	Column B	Column C
row 1A	row 1B	row 1C
row 2A	row 2B	row 2C

CSV table

Column A	Column B	Column C
row 1A	row 1B	row 1C
row 2A	row 2B	row 2C

Images

Maths

Go to Equations

Terms

term (up to a line of text)

Definition of the term, which must be indented

and can even consist of multiple paragraphs

next term

Description.

Blocks

Literal Block

This is a normal text paragraph. The next paragraph is a code sample:

It is not processed in any way, except
that the indentation is removed.

It can span multiple lines.

This is a normal text paragraph again.

Doctest blocks

>>> 1 + 1
2

Raw HTML

This is a HTML H1 heading

---

Structure

TOC Tree

Link

.. toctree::

Include text

Just a small note to be included by the include directive.

Meta data

Added but you can see it. It’s shown in HTML source.

Example:

.. meta::
   :http-equiv=Content-Type: text/html; charset=ISO-8859-1

Tags

Configuration

Link

To explore

• exclude_patterns