forked from ttscoff/cheaters
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request ttscoff#11 from shalicke/pr_rst
Adding the restructuredText cheatsheet.
- Loading branch information
Showing
2 changed files
with
137 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| <pre> | ||
|
|
||
| ===================================================== | ||
| The reStructuredText_ Cheat Sheet: Syntax Reminders | ||
| ===================================================== | ||
| :Info: See <http://docutils.sf.net/rst.html> for introductory docs. | ||
| :Author: David Goodger <goodger@python.org> | ||
| :Date: $Date: 2013-02-20 01:10:53 +0000 (Wed, 20 Feb 2013) $ | ||
| :Revision: $Revision: 7612 $ | ||
| :Description: This is a "docinfo block", or bibliographic field list | ||
|
|
||
| .. NOTE:: If you are reading this as HTML, please read | ||
| `<cheatsheet.txt>`_ instead to see the input syntax examples! | ||
|
|
||
| Section Structure | ||
| ================= | ||
| Section titles are underlined or overlined & underlined. | ||
|
|
||
| Body Elements | ||
| ============= | ||
| Grid table: | ||
|
|
||
| +--------------------------------+-----------------------------------+ | ||
| | Paragraphs are flush-left, | Literal block, preceded by "::":: | | ||
| | separated by blank lines. | | | ||
| | | Indented | | ||
| | Block quotes are indented. | | | ||
| +--------------------------------+ or:: | | ||
| | >>> print 'Doctest block' | | | ||
| | Doctest block | > Quoted | | ||
| +--------------------------------+-----------------------------------+ | ||
| | | Line blocks preserve line breaks & indents. [new in 0.3.6] | | ||
| | | Useful for addresses, verse, and adornment-free lists; long | | ||
| | lines can be wrapped with continuation lines. | | ||
| +--------------------------------------------------------------------+ | ||
|
|
||
| Simple tables: | ||
|
|
||
| ================ ============================================================ | ||
| List Type Examples (syntax in the `text source <cheatsheet.txt>`_) | ||
| ================ ============================================================ | ||
| Bullet list * items begin with "-", "+", or "*" | ||
| Enumerated list 1. items use any variation of "1.", "A)", and "(i)" | ||
| #. also auto-enumerated | ||
| Definition list Term is flush-left : optional classifier | ||
| Definition is indented, no blank line between | ||
| Field list :field name: field body | ||
| Option list -o at least 2 spaces between option & description | ||
| ================ ============================================================ | ||
|
|
||
| ================ ============================================================ | ||
| Explicit Markup Examples (visible in the `text source`_) | ||
| ================ ============================================================ | ||
| Footnote .. [1] Manually numbered or [#] auto-numbered | ||
| (even [#labelled]) or [*] auto-symbol | ||
| Citation .. [CIT2002] A citation. | ||
| Hyperlink Target .. _reStructuredText: http://docutils.sf.net/rst.html | ||
| .. _indirect target: reStructuredText_ | ||
| .. _internal target: | ||
| Anonymous Target __ http://docutils.sf.net/docs/ref/rst/restructuredtext.html | ||
| Directive ("::") .. image:: images/biohazard.png | ||
| Substitution Def .. |substitution| replace:: like an inline directive | ||
| Comment .. is anything else | ||
| Empty Comment (".." on a line by itself, with blank lines before & after, | ||
| used to separate indentation contexts) | ||
| ================ ============================================================ | ||
|
|
||
| Inline Markup | ||
| ============= | ||
| *emphasis*; **strong emphasis**; `interpreted text`; `interpreted text | ||
| with role`:emphasis:; ``inline literal text``; standalone hyperlink, | ||
| http://docutils.sourceforge.net; named reference, reStructuredText_; | ||
| `anonymous reference`__; footnote reference, [1]_; citation reference, | ||
| [CIT2002]_; |substitution|; _`inline internal target`. | ||
|
|
||
| Directive Quick Reference | ||
| ========================= | ||
| See <http://docutils.sf.net/docs/ref/rst/directives.html> for full info. | ||
|
|
||
| ================ ============================================================ | ||
| Directive Name Description (Docutils version added to, in [brackets]) | ||
| ================ ============================================================ | ||
| attention Specific admonition; also "caution", "danger", | ||
| "error", "hint", "important", "note", "tip", "warning" | ||
| admonition Generic titled admonition: ``.. admonition:: By The Way`` | ||
| image ``.. image:: picture.png``; many options possible | ||
| figure Like "image", but with optional caption and legend | ||
| topic ``.. topic:: Title``; like a mini section | ||
| sidebar ``.. sidebar:: Title``; like a mini parallel document | ||
| parsed-literal A literal block with parsed inline markup | ||
| rubric ``.. rubric:: Informal Heading`` | ||
| epigraph Block quote with class="epigraph" | ||
| highlights Block quote with class="highlights" | ||
| pull-quote Block quote with class="pull-quote" | ||
| compound Compound paragraphs [0.3.6] | ||
| container Generic block-level container element [0.3.10] | ||
| table Create a titled table [0.3.1] | ||
| list-table Create a table from a uniform two-level bullet list [0.3.8] | ||
| csv-table Create a table from CSV data [0.3.4] | ||
| contents Generate a table of contents | ||
| sectnum Automatically number sections, subsections, etc. | ||
| header, footer Create document decorations [0.3.8] | ||
| target-notes Create an explicit footnote for each external target | ||
| math Mathematical notation (input in LaTeX format) | ||
| meta HTML-specific metadata | ||
| include Read an external reST file as if it were inline | ||
| raw Non-reST data passed untouched to the Writer | ||
| replace Replacement text for substitution definitions | ||
| unicode Unicode character code conversion for substitution defs | ||
| date Generates today's date; for substitution defs | ||
| class Set a "class" attribute on the next element | ||
| role Create a custom interpreted text role [0.3.2] | ||
| default-role Set the default interpreted text role [0.3.10] | ||
| title Set the metadata document title [0.3.10] | ||
| ================ ============================================================ | ||
|
|
||
| Interpreted Text Role Quick Reference | ||
| ===================================== | ||
| See <http://docutils.sf.net/docs/ref/rst/roles.html> for full info. | ||
|
|
||
| ================ ============================================================ | ||
| Role Name Description | ||
| ================ ============================================================ | ||
| emphasis Equivalent to *emphasis* | ||
| literal Equivalent to ``literal`` but processes backslash escapes | ||
| math Mathematical notation (input in LaTeX format) | ||
| PEP Reference to a numbered Python Enhancement Proposal | ||
| RFC Reference to a numbered Internet Request For Comments | ||
| raw For non-reST data; cannot be used directly (see docs) [0.3.6] | ||
| strong Equivalent to **strong** | ||
| sub Subscript | ||
| sup Superscript | ||
| title Title reference (book, etc.); standard default role | ||
| ================ ============================================================ | ||
| </pre> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters