============ rST 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`_. .. _pycon: http://us.pycon.org .. _pyohio: http://pyohio.org .. _`Ohio LinuxFest`: http://ohiolinux.org Come to PyCon_ and PyOhio_! Footnotes --------- Ohio Linuxfest is "a great conference with something of value in all the sessions" [#ian]_ and "an excellent, excellent event" [#jono]_. .. [#ian] Ian Hodge, *LinuxPlanet* .. [#jono] Jono Bacon Lists ----- * Asterisks and * dashes can be bullets - indentation - shows nesting * plus-signs are bullets, too Enumerated lists ---------------- a) Explicit numbering b) by letters .. i. several numbering ii. schemes are iii. supported .. #. Automatic numbering #. is #. 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 ------ .. image:: pyohio.jpeg :width: 400px :alt: PyOhio logo .. hint:: `image` is just one type of rST "directive". `hint` is another. Substitution ------------ .. sidebar:: Sidebars Sidebars: yet another interesting rST "directive". |PyOhio| is proud to support |OLF|. Come to the |PyOhio| table in the exhibit area - we'll tell you all about |PyOhio|. .. |olf| replace:: *Ohio LinuxFest* .. |pyohio| image:: pyohio.jpeg :height: 1.2em Interpreted text roles ---------------------- :emphasis:`interpreted text` is text we do something to, as prosaic as :strong:`strong emphasis` or specific as a Python Enhancement Proposal reference like :PEP:`12`. You can do :sup:`superscripts` and :sub:`subscripts`. You may need to escape whitespace, like this: Ice cubes are H\ :sub:`2`\ O\ :sup:`3` ! 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 -------------------