reStructuredText Primer

Contents

• reStructuredText Primer
  • Mock-up
  • Sections
  • Inline markup
  • HyperLinks
  • Tables
  • Reference

Mock-up

sphinx-build -b html sourceFolder destinationFolder

Sections

• # with overline, for parts
• * with overline, for chapters
• =, for sections
• -, for subsections
• ^, for subsubsections
• ", for paragraphs

Inline markup

The standard reST inline markup is quite simple: use

• one asterisk: *text* for emphasis (italics),
• two asterisks: **text** for strong emphasis (boldface), and
• backquotes: ``text`` for code samples.

HyperLinks

Check Here for more details. [1]

Tables

+------------------------+------------+----------+----------+
| Header row, column 1   | Header 2   | Header 3 | Header 4 |
| (header rows optional) |            |          |          |
+========================+============+==========+==========+
| body row 1, column 1   | column 2   | column 3 | column 4 |
+------------------------+------------+----------+----------+
| body row 2             | ...        | ...      |          |
+------------------------+------------+----------+----------+

=====  =====  =======
A      B      A and B
=====  =====  =======
False  False  False
True   False  False
False  True   False
True   True   True
=====  =====  =======

Reference

[1]	http://sphinx.pocoo.org/markup/inline.html#ref-role

[2]	http://sphinx.pocoo.org/rest.html

[3]	http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html