matplotlib.github.com/sampledoc/emacs_help.html at plausible · matplotlib/matplotlib.github.com · GitHub

History

152 lines (130 loc) · 7.98 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>Emacs ReST support — sampledoc 1.0 documentation</title>

var DOCUMENTATION_OPTIONS = {

URL_ROOT: './',

VERSION: '1.0',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true,

SOURCELINK_SUFFIX: '.txt'

};

</script>

</head>

<a href="index.html"><h1 style="font-size: 3em;">Sampledoc</h1></a>

</div>

<h3>Navigation</h3>

<ul>

<a href="genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="cheatsheet.html" title="Sphinx cheat sheet"

accesskey="P">previous</a> |</li>

<li><a href="search.html">search</a>| </li>

</ul>

</div>

<h3><a href="index.html">Table Of Contents</a></h3>

<ul>

<li><a class="reference internal" href="#">Emacs ReST support</a><ul>

<li><a class="reference internal" href="#emacs-helpers">Emacs helpers</a></li>

</ul>

</li>

</ul>

<h4>Previous topic</h4>

<p class="topless"><a href="cheatsheet.html"

title="previous chapter">Sphinx cheat sheet</a></p>

<li><a href="_sources/emacs_help.rst.txt"

rel="nofollow">Show Source</a></li>

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

</div>

<span id="working-with-emacs"></span><h1>Emacs ReST support<a class="headerlink" href="#emacs-rest-support" title="Permalink to this headline">¶</a></h1>

<h2>Emacs helpers<a class="headerlink" href="#emacs-helpers" title="Permalink to this headline">¶</a></h2>

<p>There is an emacs mode <a class="reference external" href="http://docutils.sourceforge.net/tools/editors/emacs/rst.el">rst.el</a> which

automates many important ReST tasks like building and updateing

table-of-contents, and promoting or demoting section headings. Here

is the basic <code class="docutils literal"><span class="pre">.emacs</span></code> configuration:</p>

<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">(</span><span class="n">require</span> <span class="s1">'rst)</span>

<span class="p">(</span><span class="n">setq</span> <span class="n">auto</span><span class="o">-</span><span class="n">mode</span><span class="o">-</span><span class="n">alist</span>

<span class="p">(</span><span class="n">append</span> <span class="s1">'(("</span><span class="se">\\</span><span class="s1">.txt$" . rst-mode)</span>

<span class="p">(</span><span class="s2">"</span><span class="se">\\</span><span class="s2">.rest$"</span> <span class="o">.</span> <span class="n">rst</span><span class="o">-</span><span class="n">mode</span><span class="p">))</span> <span class="n">auto</span><span class="o">-</span><span class="n">mode</span><span class="o">-</span><span class="n">alist</span><span class="p">))</span>

</pre></div>

</div>

<p>Some helpful functions:</p>

<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">C</span><span class="o">-</span><span class="n">c</span> <span class="n">TAB</span> <span class="o">-</span> <span class="n">rst</span><span class="o">-</span><span class="n">toc</span><span class="o">-</span><span class="n">insert</span>

<span class="n">Insert</span> <span class="n">table</span> <span class="n">of</span> <span class="n">contents</span> <span class="n">at</span> <span class="n">point</span>

<span class="n">C</span><span class="o">-</span><span class="n">c</span> <span class="n">C</span><span class="o">-</span><span class="n">u</span> <span class="o">-</span> <span class="n">rst</span><span class="o">-</span><span class="n">toc</span><span class="o">-</span><span class="n">update</span>

<span class="n">Update</span> <span class="n">the</span> <span class="n">table</span> <span class="n">of</span> <span class="n">contents</span> <span class="n">at</span> <span class="n">point</span>

<span class="n">C</span><span class="o">-</span><span class="n">c</span> <span class="n">C</span><span class="o">-</span><span class="n">l</span> <span class="n">rst</span><span class="o">-</span><span class="n">shift</span><span class="o">-</span><span class="n">region</span><span class="o">-</span><span class="n">left</span>

<span class="n">Shift</span> <span class="n">region</span> <span class="n">to</span> <span class="n">the</span> <span class="n">left</span>

<span class="n">C</span><span class="o">-</span><span class="n">c</span> <span class="n">C</span><span class="o">-</span><span class="n">r</span> <span class="n">rst</span><span class="o">-</span><span class="n">shift</span><span class="o">-</span><span class="n">region</span><span class="o">-</span><span class="n">right</span>

<span class="n">Shift</span> <span class="n">region</span> <span class="n">to</span> <span class="n">the</span> <span class="n">right</span>

</pre></div>

</div>

</div>

<h3>Navigation</h3>

<ul>

<a href="genindex.html" title="General Index"

>index</a></li>

<a href="cheatsheet.html" title="Sphinx cheat sheet"

>previous</a> |</li>

<li><a href="search.html">search</a>| </li>

</ul>

</div>

Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.1.

</div>

</body>

</html>

matplotlib.github.com/sampledoc/emacs_help.html at plausible · matplotlib/matplotlib.github.com · GitHub

Expand file tree

Breadcrumbs

emacs_help.html

Latest commit

History

Breadcrumbs

emacs_help.html

File metadata and controls