<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.9.1: http://docutils.sourceforge.net/" />
<title>The reStructuredText Cheat Sheet: Syntax Reminders</title>
<meta name="author" content="David Goodger <goodger@python.org>" />
<meta name="date" content="2012-06-22" />
<style type="text/css">
/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 7434 2012-05-11 21:06:27Z milde $
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/
/* used to remove borders from tables and images */
.borde
rendered rst html used in screenshot (pre-crop)
This change has been marked as completed.
Pushed to release-1.7.x (b898885). Thanks!
raw rst file used in screenshot | |
---|---|
1 | ===================================================== |
2 | The reStructuredText_ Cheat Sheet: Syntax Reminders |
3 | ===================================================== |
4 | :Info: See <http://docutils.sf.net/rst.html> for introductory docs. |
5 | :Author: David Goodger <goodger@python.org> |
6 | :Date: $Date: 2012-06-22 19:49:51 +0000 (Fri, 22 Jun 2012) $ |
7 | :Revision: $Revision: 7463 $ |
8 | :Description: This is a "docinfo block", or bibliographic field list |
9 | |
10 | Section Structure |
11 | ================= |
12 | Section titles are underlined or overlined & underlined. |
13 | |
14 | Body Elements |
15 | ============= |
16 | Grid table: |
17 | |
18 | +--------------------------------+-----------------------------------+ |
19 | | Paragraphs are flush-left, | Literal block, preceded by "::":: | |
20 | | separated by blank lines. | | |
21 | | | Indented | |
22 | | Block quotes are indented. | | |
23 | +--------------------------------+ or:: | |
24 | | >>> print 'Doctest block' | | |
25 | | Doctest block | > Quoted | |
26 | +--------------------------------+-----------------------------------+ |
27 | | | Line blocks preserve line breaks & indents. [new in 0.3.6] | |
28 | | | Useful for addresses, verse, and adornment-free lists; long | |
29 | | lines can be wrapped with continuation lines. | |
30 | +--------------------------------------------------------------------+ |
31 | |
32 | Simple tables: |
33 | |
34 | ================ ============================================================ |
35 | List Type Examples |
36 | ================ ============================================================ |
37 | Bullet list * items begin with "-", "+", or "*" |
38 | Enumerated list 1. items use any variation of "1.", "A)", and "(i)" |
39 | #. also auto-enumerated |
40 | Definition list Term is flush-left : optional classifier |
41 | Definition is indented, no blank line between |
42 | Field list :field name: field body |
43 | Option list -o at least 2 spaces between option & description |
44 | ================ ============================================================ |
45 | |
46 | ================ ============================================================ |
47 | Explicit Markup Examples (visible in the `text source <cheatsheet.txt>`_) |
48 | ================ ============================================================ |
49 | Footnote .. [1] Manually numbered or [#] auto-numbered |
50 | (even [#labelled]) or [*] auto-symbol |
51 | Citation .. [CIT2002] A citation. |
52 | Hyperlink Target .. _reStructuredText: http://docutils.sf.net/rst.html |
53 | .. _indirect target: reStructuredText_ |
54 | .. _internal target: |
55 | Anonymous Target __ http://docutils.sf.net/docs/ref/rst/restructuredtext.html |
56 | Directive ("::") .. image:: images/biohazard.png |
57 | Substitution Def .. |substitution| replace:: like an inline directive |
58 | Comment .. is anything else |
59 | Empty Comment (".." on a line by itself, with blank lines before & after, |
60 | used to separate indentation contexts) |
61 | ================ ============================================================ |
62 | |
63 | Inline Markup |
64 | ============= |
65 | *emphasis*; **strong emphasis**; `interpreted text`; `interpreted text |
66 | with role`:emphasis:; ``inline literal text``; standalone hyperlink, |
67 | http://docutils.sourceforge.net; named reference, reStructuredText_; |
68 | `anonymous reference`__; footnote reference, [1]_; citation reference, |
69 | [CIT2002]_; |substitution|; _`inline internal target`. |
70 | |
71 | |
72 | Directive Quick Reference |
73 | ========================= |
74 | See <http://docutils.sf.net/docs/ref/rst/directives.html> for full info. |
75 | |
76 | ================ ============================================================ |
77 | Directive Name Description (Docutils version added to, in [brackets]) |
78 | ================ ============================================================ |
79 | attention Specific admonition; also "caution", "danger", |
80 | "error", "hint", "important", "note", "tip", "warning" |
81 | admonition Generic titled admonition: ``.. admonition:: By The Way`` |
82 | image ``.. image:: picture.png``; many options possible |
83 | figure Like "image", but with optional caption and legend |
84 | topic ``.. topic:: Title``; like a mini section |
85 | sidebar ``.. sidebar:: Title``; like a mini parallel document |
86 | parsed-literal A literal block with parsed inline markup |
87 | rubric ``.. rubric:: Informal Heading`` |
88 | epigraph Block quote with class="epigraph" |
89 | highlights Block quote with class="highlights" |
90 | pull-quote Block quote with class="pull-quote" |
91 | compound Compound paragraphs [0.3.6] |
92 | container Generic block-level container element [0.3.10] |
93 | table Create a titled table [0.3.1] |
94 | list-table Create a table from a uniform two-level bullet list [0.3.8] |
95 | csv-table Create a table from CSV data [0.3.4] |
96 | contents Generate a table of contents |
97 | sectnum Automatically number sections, subsections, etc. |
98 | header, footer Create document decorations [0.3.8] |
99 | target-notes Create an explicit footnote for each external target |
100 | math Mathematical notation (input in LaTeX format) |
101 | meta HTML-specific metadata |
102 | include Read an external reST file as if it were inline |
103 | raw Non-reST data passed untouched to the Writer |
104 | replace Replacement text for substitution definitions |
105 | unicode Unicode character code conversion for substitution defs |
106 | date Generates today's date; for substitution defs |
107 | class Set a "class" attribute on the next element |
108 | role Create a custom interpreted text role [0.3.2] |
109 | default-role Set the default interpreted text role [0.3.10] |
110 | title Set the metadata document title [0.3.10] |
111 | ================ ============================================================ |
112 | |
113 | Interpreted Text Role Quick Reference |
114 | ===================================== |
115 | See <http://docutils.sf.net/docs/ref/rst/roles.html> for full info. |
116 | |
117 | ================ ============================================================ |
118 | Role Name Description |
119 | ================ ============================================================ |
120 | emphasis Equivalent to *emphasis* |
121 | literal Equivalent to ``literal`` but processes backslash escapes |
122 | math Mathematical notation (input in LaTeX format) |
123 | PEP Reference to a numbered Python Enhancement Proposal |
124 | RFC Reference to a numbered Internet Request For Comments |
125 | raw For non-reST data; cannot be used directly (see docs) [0.3.6] |
126 | strong Equivalent to **strong** |
127 | sub Subscript |
128 | sup Superscript |
129 | title Title reference (book, etc.); standard default role |
130 | ================ ============================================================ |