reStructuredText style demo =========================== This is a simple demo of a subset of reStructuredText features. Inline markup ------------- The *quick* brown **fox** jumps ``over`` :superscript:`the` lazy :subscript:`dog`. :title-reference:`Title reference.` Lorem ipsum [Ref]_ dolor sit amet. .. [Ref] Book or article reference, URL or whatever. Lorem ipsum [#f1]_ dolor sit amet ... [#f2]_ .. rubric:: Footnotes .. [#f1] Text of the first footnote. .. [#f2] Text of the second footnote. Lists and quote-like blocks --------------------------- * Bulleted list * with two items #. Numbered list #. with #. three items * Nested #. List * Hooray * Hooray * Hooray * Hooray #. List * Hooray * Hooray * Hooray * Hooray * Nested #. List term (up to a line of text) Definition of the term, which must be indented and can even consist of multiple paragraphs next term Description. Paragraph heading """"""""""""""""" .. contents:: Local table of contents (The above ToC triggers anchors around all page headings beyond what Sphinx does.) .. topic:: Topic A topic is like a block quote with a title, or a self-contained section with no subsections. Use the "topic" directive to indicate a self-contained idea that is separate from the flow of the document. Topics may occur anywhere a section or transition may occur. Body elements and topics may not contain nested topics. .. parsed-literal:: parsed-literal is a literal-looking block with **parsed** *text* Epigraph ^^^^^^^^ .. epigraph:: No matter where you go, there you are. -- Buckaroo Banzai Compound paragraph ^^^^^^^^^^^^^^^^^^ .. compound:: This is a compound paragraph. The 'rm' command is very dangerous. If you are logged in as root and enter :: cd / rm -rf * you will erase the entire contents of your file system. Raw HTML ^^^^^^^^ .. raw:: html This is some raw HTML. Sidebar ------- .. sidebar:: Sidebar Sidebars are like miniature, parallel documents that occur inside other documents, providing related or reference material. A sidebar is typically offset by a border and "floats" to the side of the page; the document's main text may flow around it. Sidebars can also be likened to super-footnotes; their content is outside of the flow of the document's main text. Admonition blocks ----------------- .. attention:: attention block block block block block block block block block block block .. caution:: caution block .. danger:: danger block .. error:: error block .. hint:: hint block .. important:: important block .. note:: note block .. tip:: tip block .. warning:: warning block .. admonition:: custom admonition with content