IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-09-03 20:52:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

[Carl Cerecke] Reword first section.

Browse Source
This commit is contained in:
Georg Brandl
2007-07-29 08:27:57 +00:00
parent a58d42094c
commit fa844c2634
1 changed files with 10 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
converter/newfiles/doc_rest.rst
+10 -7
View File
@@ -4,22 +4,25 @@ reStructuredText Primer
=======================
This section is a brief introduction to reStructuredText (reST) concepts and
syntax, to provide authors enough information to autor documents productively.
syntax, intended to provide authors with enough information to author
documents productively.
Since reST was designed to be a simple, unobtrusive markup language, this will
not take too long.
.. seealso::
The authoritative `reStructuredText User
Documentation <http://docutils.sourceforge.net/rst.html>`_.
The authoritative `reStructuredText User
Documentation <http://docutils.sourceforge.net/rst.html>`_.
Paragraphs
----------
The most basic block a reST document is made of. Paragraphs are chunks of text
separated by one ore more blank lines. As in Python, indentation is significant
in reST, so all lines of a paragraph must be left-aligned.
The paragraph is the most basic block in a reST document.
Paragraphs are simply chunks of text
separated by one or more blank lines. As in Python, indentation is significant
in reST, so all lines of the same paragraph must be left-aligned
to the same level of indentation.
Inline markup
@@ -226,4 +229,4 @@ All Python documentation source files must be in UTF-8 encoding, and the HTML
documents written from them will be in that encoding as well.
XXX: Gotchas
XXX: Gotchas