reST examples

Whitespace

This is a paragraph with some inline markup. Line breaks don't matter,

but blank lines do.

A text block that is indented relative to the preceding text, without preceding markup indicating it to be a literal block or other content, is a block quote.

—reStructuredText Markup Specification

Sections

and subsections

and sub-subsections

Each new underline character used creates a new, lower level in the secion hierarchy.

next subsection

another sub-subsection

don't overdo it

References

Internal, like this reference to the whitespace section, or external, like this link to PyCon. They can span multiple words, like Ohio LinuxFest.

Come to PyCon and PyOhio!

Footnotes

Ohio Linuxfest is "a great conference with something of value in all the sessions" [1] and "an excellent, excellent event" [2].

[1]Ian Hodge, LinuxPlanet
[2]Jono Bacon

Lists

Enumerated lists

  1. Explicit numbering
  2. by letters
  1. several numbering
  2. schemes are
  3. supported
  1. Automatic numbering
  2. is
  3. handy

Literals

Individual phrases can be rendered as literals

Whole blocks can, too:

def count(thing):
    for i in range(3):
        print i+1
        print '%d %s' % (i+1, thing)
    print 'Ah ha ha ha ha!'

Images

PyOhio logo

Hint

image is just one type of reST "directive". hint is another.

Substitution

Sidebars

Sidebars: yet another interesting reST "directive".

pyohio is proud to support Ohio LinuxFest. Come to the pyohio table in the exhibit area - we'll tell you all about pyohio.

Interpreted text roles

interpreted text is text we do something to, as prosaic as strong emphasis or specific as a Python Enhancement Proposal reference like PEP 12.

You can do superscripts and subscripts. You may need to escape whitespace, like this: Ice cubes are H2O3 !

Tables

Event When Where
OLF Sep 25 - 27 Columbus, OH
PyCon Feb 17 - 25 Atlanta, GA
pyohio Jul 31 - Aug 1 Columbus, OH
CodeMash Jan 13 - 15 Sandusky, OH
PenguiCon Apr 30 - May 2 Troy, MI

And much, much more