<spanid="cheat-sheet"></span><h1>Sphinx cheat sheet<aclass="headerlink" href="#sphinx-cheat-sheet" title="Permalink to this headline">¶</a></h1>
<p>Here is a quick and dirty cheat sheet for some common stuff you want
to do in sphinx and ReST. You can see the literal source for this
file at <aclass="reference internal" href="#cheatsheet-literal"><spanclass="std std-ref">This file</span></a>.</p>
<divclass="section" id="formatting-text">
<spanid="id1"></span><h2>Formatting text<aclass="headerlink" href="#formatting-text" title="Permalink to this headline">¶</a></h2>
<p>You use inline markup to make text <em>italics</em>, <strong>bold</strong>, or <codeclass="docutils literal"><spanclass="pre">monotype</span></code>.</p>
<p>You can represent code blocks fairly easily:</p>
<spanid="id2"></span><h2>Making a list<aclass="headerlink" href="#making-a-list" title="Permalink to this headline">¶</a></h2>
<p>It is easy to make lists in rest</p>
<divclass="section" id="bullet-points">
<h3>Bullet points<aclass="headerlink" href="#bullet-points" title="Permalink to this headline">¶</a></h3>
<p>This is a subsection making bullet points</p>
<ulclass="simple">
<li>point A</li>
<li>point B</li>
<li>point C</li>
</ul>
</div>
<divclass="section" id="enumerated-points">
<h3>Enumerated points<aclass="headerlink" href="#enumerated-points" title="Permalink to this headline">¶</a></h3>
<p>This is a subsection making numbered points</p>
<olclass="arabic simple">
<li>point A</li>
<li>point B</li>
<li>point C</li>
</ol>
</div>
</div>
<divclass="section" id="making-a-table">
<spanid="id3"></span><h2>Making a table<aclass="headerlink" href="#making-a-table" title="Permalink to this headline">¶</a></h2>
<p>This shows you how to make a table – if you only want to make a list see <aclass="reference internal" href="#making-a-list"><spanclass="std std-ref">Making a list</span></a>.</p>
<tableborder="1" class="docutils">
<colgroup>
<colwidth="60%" />
<colwidth="40%" />
</colgroup>
<theadvalign="bottom">
<trclass="row-odd"><thclass="head">Name</th>
<thclass="head">Age</th>
</tr>
</thead>
<tbodyvalign="top">
<trclass="row-even"><td>John D Hunter</td>
<td>40</td>
</tr>
<trclass="row-odd"><td>Cast of Thousands</td>
<td>41</td>
</tr>
<trclass="row-even"><td>And Still More</td>
<td>42</td>
</tr>
</tbody>
</table>
</div>
<divclass="section" id="making-links">
<spanid="id4"></span><h2>Making links<aclass="headerlink" href="#making-links" title="Permalink to this headline">¶</a></h2>
<p>It is easy to make a link to <aclass="reference external" href="http://yahoo.com">yahoo</a> or to some
section inside this document (see <aclass="reference internal" href="#making-a-table"><spanclass="std std-ref">Making a table</span></a>) or another
document.</p>
<p>You can also reference classes, modules, functions, etc that are
documented using the sphinx <aclass="reference external" href="http://sphinx.pocoo.org/ext/autodoc.html">autodoc</a> facilites. For example,
see the module <codeclass="xref py py-mod docutils literal"><spanclass="pre">matplotlib.backend_bases</span></code> documentation, or the
class <codeclass="xref py py-class docutils literal"><spanclass="pre">LocationEvent</span></code>, or the method