reStructuredText mode

 
1
.. This is an excerpt from Sphinx documentation: http://sphinx.pocoo.org/_sources/rest.txt
2
3
.. highlightlang:: rest
4
5
.. _rst-primer:
6
7
reStructuredText Primer
8
=======================
9
10
This section is a brief introduction to reStructuredText (reST) concepts and
11
syntax, intended to provide authors with enough information to author documents
12
productively.  Since reST was designed to be a simple, unobtrusive markup
13
language, this will not take too long.
14
15
.. seealso::
16
17
   The authoritative `reStructuredText User Documentation
18
   <http://docutils.sourceforge.net/rst.html>`_.  The "ref" links in this
19
   document link to the description of the individual constructs in the reST
20
   reference.
21
22
23
Paragraphs
24
----------
25
26
The paragraph (:duref:`ref <paragraphs>`) is the most basic block in a reST
27
document.  Paragraphs are simply chunks of text separated by one or more blank
28
lines.  As in Python, indentation is significant in reST, so all lines of the
29
same paragraph must be left-aligned to the same level of indentation.
30
31
32
.. _inlinemarkup:

The python mode will be used for highlighting blocks containing Python/IPython terminal sessions: blocks starting with >>> (for Python) or In [num]: (for IPython). Further, the stex mode will be used for highlighting blocks containing LaTex code.

MIME types defined: text/x-rst.