source: pulse_train_doc/build/html/coaching1.html @ 864

Last change on this file since 864 was 864, checked in by jemian, 10 years ago

properties

  • Property svn:mime-type set to text/html
File size: 30.6 KB
Line 
1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6
7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
11    <title>Coaching on the use of reStructuredText &mdash; pulse_train 2012-06 documentation</title>
12   
13    <link rel="stylesheet" href="_static/default.css" type="text/css" />
14    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
15   
16    <script type="text/javascript">
17      var DOCUMENTATION_OPTIONS = {
18        URL_ROOT:    '',
19        VERSION:     '2012-06',
20        COLLAPSE_INDEX: false,
21        FILE_SUFFIX: '.html',
22        HAS_SOURCE:  true
23      };
24    </script>
25    <script type="text/javascript" src="_static/jquery.js"></script>
26    <script type="text/javascript" src="_static/underscore.js"></script>
27    <script type="text/javascript" src="_static/doctools.js"></script>
28    <link rel="top" title="pulse_train 2012-06 documentation" href="index.html" />
29    <link rel="prev" title="Documentation of Programmable pulse train" href="index.html" /> 
30  </head>
31  <body>
32    <div class="related">
33      <h3>Navigation</h3>
34      <ul>
35        <li class="right" style="margin-right: 10px">
36          <a href="genindex.html" title="General Index"
37             accesskey="I">index</a></li>
38        <li class="right" >
39          <a href="index.html" title="Documentation of Programmable pulse train"
40             accesskey="P">previous</a> |</li>
41        <li><a href="index.html">pulse_train 2012-06 documentation</a> &raquo;</li> 
42      </ul>
43    </div> 
44
45    <div class="document">
46      <div class="documentwrapper">
47        <div class="bodywrapper">
48          <div class="body">
49           
50  <div class="section" id="coaching-on-the-use-of-restructuredtext">
51<h1>Coaching on the use of reStructuredText<a class="headerlink" href="#coaching-on-the-use-of-restructuredtext" title="Permalink to this headline">¶</a></h1>
52<div class="admonition note">
53<p class="first admonition-title">Note</p>
54<p class="last">Web documentation available at:
55<a class="reference external" href="http://subversion.xor.aps.anl.gov/bcdaext/pulse_train_doc/build/html/index.html">http://subversion.xor.aps.anl.gov/bcdaext/pulse_train_doc/build/html/index.html</a></p>
56</div>
57<p>This is a just an example of writing the documentation using sphinx.
58It is easy.  You can find the built <span class="target" id="index-0"></span>html documentation in
59<tt class="docutils literal"><span class="pre">build/html/index.html</span></tt>.  To build the documentation, you need to
60be in the <tt class="docutils literal"><span class="pre">doc</span></tt> directory, then type:</p>
61<div class="highlight-python"><pre>make html</pre>
62</div>
63<p>It may be useful, sometimes, to completely <span class="target" id="index-1"></span>rebuild the documentation.
64To do that, type:</p>
65<div class="highlight-python"><pre>make clean
66make html</pre>
67</div>
68<div class="section" id="svn-export-this-example-documentation">
69<h2>SVN export this example documentation<a class="headerlink" href="#svn-export-this-example-documentation" title="Permalink to this headline">¶</a></h2>
70<p>You can pull this example from its subversion repo and add it
71to your project by going to the desired directory
72(perhaps the TOP directory for your support) and exporting from this
73subversion repository:</p>
74<div class="highlight-python"><pre>svn export http://subversion.xor.aps.anl.gov/bcdaext/pulse_train_doc sphinxdoc</pre>
75</div>
76</div>
77<div class="section" id="example-1">
78<h2>Example 1<a class="headerlink" href="#example-1" title="Permalink to this headline">¶</a></h2>
79<p>Here is some more text.</p>
80<blockquote>
81<div>This text is an inset.</div></blockquote>
82</div>
83<div class="section" id="example-2">
84<h2>Example 2<a class="headerlink" href="#example-2" title="Permalink to this headline">¶</a></h2>
85<p>Tell about example 2.</p>
86<div class="section" id="inline-code-external-code-and-other-literal-examples">
87<h3>inline code, external code, and other literal examples<a class="headerlink" href="#inline-code-external-code-and-other-literal-examples" title="Permalink to this headline">¶</a></h3>
88<p>Use a different underline symbol for each section <span class="target" id="index-2"></span>level.  To use
89<tt class="docutils literal"><span class="pre">literal</span> <span class="pre">text</span></tt>, surround test with double backticks or end a paragraph
90with a double colon:</p>
91<div class="highlight-python"><pre>place a blank line
92then indent the text to be made to look like a program</pre>
93</div>
94<p>It is possible to include all or even part of code files in
95any accessible directory.</p>
96<div class="highlight-guess"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1
972</pre></div></td><td class="code"><div class="highlight"><pre><span class="c1"># this is some example C code</span>
98<span class="k">for</span> <span class="p">(</span><span class="n">i</span><span class="o">=</span><span class="mi">10</span><span class="p">;</span> <span class="n">i</span><span class="p">;</span> <span class="n">i</span><span class="o">--</span><span class="p">)</span>  <span class="n">i</span><span class="o">*</span><span class="n">i</span><span class="p">;</span>
99</pre></div>
100</td></tr></table></div>
101<div class="highlight-guess"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre> 1
102 2
103 3
104 4
105 5
106 6
107 7
108 8
109 9
11010
11111
11212
11313
11414
11515
11616
11717
11818
11919
12020
12121
12222
12323
12424
12525
12626
12727
12828
12929
13030
13131
13232
13333
13434
13535
13636</pre></div></td><td class="code"><div class="highlight"><pre><span class="cp">.. $Id: $</span>
137
138<span class="gh">===========================================</span>
139<span class="gh">Documentation of Programmable pulse train</span>
140<span class="gh">===========================================</span>
141
142<span class="p">..</span> <span class="ow">figure</span><span class="p">::</span> adl_screens.png
143
144   the figure caption says &quot;Three MEDM screens&quot;
145
146<span class="cp">.. this is a bit fancier for a figure, using a table </span>
147   to get a fancier title bar since the figure caption
148   above looks very plain.
149
150+-----------------+------------------------------+
151<span class="o">|</span> This table is actually a Figure!               |
152+=================+==============================+
153<span class="o">|</span>  Dff Q output:  |  .. image:: square_wave.png  |
154+-----------------+------------------------------+
155
156
157
158
159Contents:
160
161<span class="p">..</span> <span class="ow">toctree</span><span class="p">::</span>
162   <span class="nc">:maxdepth:</span> <span class="nf">3</span>
163   <span class="nc">:glob:</span>
164   
165   coaching*
166
167<span class="gh">Indices and tables</span>
168<span class="gh">==================</span>
169
170<span class="m">*</span> <span class="na">:ref:</span><span class="nv">`genindex`</span>
171<span class="m">*</span> <span class="na">:ref:</span><span class="nv">`search`</span>
172</pre></div>
173</td></tr></table></div>
174<div class="admonition note">
175<p class="first admonition-title">Note</p>
176<p class="last">More <span class="target" id="index-3"></span>help is available from the sphinx
177link (<a class="reference external" href="http://sphinx.pocoo.org/">http://sphinx.pocoo.org/</a>) at the bottom of this web page.</p>
178</div>
179</div>
180<div class="section" id="unix-makefile">
181<h3>UNIX Makefile<a class="headerlink" href="#unix-makefile" title="Permalink to this headline">¶</a></h3>
182<div class="highlight-guess"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>  1
183  2
184  3
185  4
186  5
187  6
188  7
189  8
190  9
191 10
192 11
193 12
194 13
195 14
196 15
197 16
198 17
199 18
200 19
201 20
202 21
203 22
204 23
205 24
206 25
207 26
208 27
209 28
210 29
211 30
212 31
213 32
214 33
215 34
216 35
217 36
218 37
219 38
220 39
221 40
222 41
223 42
224 43
225 44
226 45
227 46
228 47
229 48
230 49
231 50
232 51
233 52
234 53
235 54
236 55
237 56
238 57
239 58
240 59
241 60
242 61
243 62
244 63
245 64
246 65
247 66
248 67
249 68
250 69
251 70
252 71
253 72
254 73
255 74
256 75
257 76
258 77
259 78
260 79
261 80
262 81
263 82
264 83
265 84
266 85
267 86
268 87
269 88
270 89
271 90
272 91
273 92
274 93
275 94
276 95
277 96
278 97
279 98
280 99
281100
282101
283102
284103
285104
286105
287106
288107
289108
290109
291110
292111
293112
294113
295114
296115
297116
298117
299118
300119
301120
302121
303122
304123
305124
306125
307126
308127
309128
310129
311130
312131
313132
314133
315134
316135
317136
318137
319138
320139
321140
322141
323142
324143
325144
326145
327146
328147
329148
330149
331150
332151
333152
334153</pre></div></td><td class="code"><div class="highlight"><pre><span class="c1"># Makefile for Sphinx documentation</span>
335<span class="c1">#</span>
336
337<span class="c1"># You can set these variables from the command line.</span>
338<span class="n">SPHINXOPTS</span>    <span class="o">=</span>
339<span class="n">SPHINXBUILD</span>   <span class="o">=</span> <span class="n">sphinx</span><span class="o">-</span><span class="n">build</span>
340<span class="n">PAPER</span>         <span class="o">=</span>
341<span class="n">BUILDDIR</span>      <span class="o">=</span> <span class="n">build</span>
342
343<span class="c1"># Internal variables.</span>
344<span class="n">PAPEROPT_a4</span>     <span class="o">=</span> <span class="o">-</span><span class="n">D</span> <span class="n">latex_paper_size</span><span class="o">=</span><span class="n">a4</span>
345<span class="n">PAPEROPT_letter</span> <span class="o">=</span> <span class="o">-</span><span class="n">D</span> <span class="n">latex_paper_size</span><span class="o">=</span><span class="n">letter</span>
346<span class="n">ALLSPHINXOPTS</span>   <span class="o">=</span> <span class="o">-</span><span class="n">d</span> <span class="nv">$</span><span class="err">(</span><span class="nv">BUILDDIR</span><span class="p">)</span><span class="o">/</span><span class="n">doctrees</span> <span class="nv">$</span><span class="err">(</span><span class="nv">PAPEROPT_$</span><span class="err">(</span><span class="nv">PAPER</span><span class="p">))</span> <span class="nv">$</span><span class="err">(</span><span class="nv">SPHINXOPTS</span><span class="p">)</span> <span class="n">source</span>
347<span class="c1"># the i18n builder cannot share the environment and doctrees with the others</span>
348<span class="n">I18NSPHINXOPTS</span>  <span class="o">=</span> <span class="nv">$</span><span class="err">(</span><span class="nv">PAPEROPT_$</span><span class="err">(</span><span class="nv">PAPER</span><span class="p">))</span> <span class="nv">$</span><span class="err">(</span><span class="nv">SPHINXOPTS</span><span class="p">)</span> <span class="n">source</span>
349
350<span class="o">.</span><span class="n">PHONY:</span> <span class="n">help</span> <span class="n">clean</span> <span class="n">html</span> <span class="n">dirhtml</span> <span class="n">singlehtml</span> <span class="n">pickle</span> <span class="n">json</span> <span class="n">htmlhelp</span> <span class="n">qthelp</span> <span class="n">devhelp</span> <span class="n">epub</span> <span class="n">latex</span> <span class="n">latexpdf</span> <span class="n">text</span> <span class="n">man</span> <span class="n">changes</span> <span class="n">linkcheck</span> <span class="n">doctest</span> <span class="n">gettext</span>
351
352<span class="n">help:</span>
353        <span class="nv">@echo</span> <span class="s">&quot;Please use \`make &lt;target&gt;&#39; where &lt;target&gt; is one of&quot;</span>
354        <span class="nv">@echo</span> <span class="s">&quot;  html       to make standalone HTML files&quot;</span>
355        <span class="nv">@echo</span> <span class="s">&quot;  dirhtml    to make HTML files named index.html in directories&quot;</span>
356        <span class="nv">@echo</span> <span class="s">&quot;  singlehtml to make a single large HTML file&quot;</span>
357        <span class="nv">@echo</span> <span class="s">&quot;  pickle     to make pickle files&quot;</span>
358        <span class="nv">@echo</span> <span class="s">&quot;  json       to make JSON files&quot;</span>
359        <span class="nv">@echo</span> <span class="s">&quot;  htmlhelp   to make HTML files and a HTML help project&quot;</span>
360        <span class="nv">@echo</span> <span class="s">&quot;  qthelp     to make HTML files and a qthelp project&quot;</span>
361        <span class="nv">@echo</span> <span class="s">&quot;  devhelp    to make HTML files and a Devhelp project&quot;</span>
362        <span class="nv">@echo</span> <span class="s">&quot;  epub       to make an epub&quot;</span>
363        <span class="nv">@echo</span> <span class="s">&quot;  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter&quot;</span>
364        <span class="nv">@echo</span> <span class="s">&quot;  latexpdf   to make LaTeX files and run them through pdflatex&quot;</span>
365        <span class="nv">@echo</span> <span class="s">&quot;  text       to make text files&quot;</span>
366        <span class="nv">@echo</span> <span class="s">&quot;  man        to make manual pages&quot;</span>
367        <span class="nv">@echo</span> <span class="s">&quot;  texinfo    to make Texinfo files&quot;</span>
368        <span class="nv">@echo</span> <span class="s">&quot;  info       to make Texinfo files and run them through makeinfo&quot;</span>
369        <span class="nv">@echo</span> <span class="s">&quot;  gettext    to make PO message catalogs&quot;</span>
370        <span class="nv">@echo</span> <span class="s">&quot;  changes    to make an overview of all changed/added/deprecated items&quot;</span>
371        <span class="nv">@echo</span> <span class="s">&quot;  linkcheck  to check all external links for integrity&quot;</span>
372        <span class="nv">@echo</span> <span class="s">&quot;  doctest    to run all doctests embedded in the documentation (if enabled)&quot;</span>
373
374<span class="n">clean:</span>
375        <span class="o">-</span><span class="n">rm</span> <span class="o">-</span><span class="n">rf</span> <span class="nv">$</span><span class="err">(</span><span class="nv">BUILDDIR</span><span class="p">)</span><span class="o">/*</span>
376
377<span class="n">html:</span>
378        <span class="nv">$</span><span class="err">(</span><span class="nv">SPHINXBUILD</span><span class="p">)</span> <span class="o">-</span><span class="n">b</span> <span class="n">html</span> <span class="nv">$</span><span class="err">(</span><span class="nv">ALLSPHINXOPTS</span><span class="p">)</span> <span class="nv">$</span><span class="err">(</span><span class="nv">BUILDDIR</span><span class="p">)</span><span class="o">/</span><span class="n">html</span>
379        <span class="nv">@echo</span>
380        <span class="nv">@echo</span> <span class="s">&quot;Build finished. The HTML pages are in $(BUILDDIR)/html.&quot;</span>
381
382<span class="n">dirhtml:</span>
383        <span class="nv">$</span><span class="err">(</span><span class="nv">SPHINXBUILD</span><span class="p">)</span> <span class="o">-</span><span class="n">b</span> <span class="n">dirhtml</span> <span class="nv">$</span><span class="err">(</span><span class="nv">ALLSPHINXOPTS</span><span class="p">)</span> <span class="nv">$</span><span class="err">(</span><span class="nv">BUILDDIR</span><span class="p">)</span><span class="o">/</span><span class="n">dirhtml</span>
384        <span class="nv">@echo</span>
385        <span class="nv">@echo</span> <span class="s">&quot;Build finished. The HTML pages are in $(BUILDDIR)/dirhtml.&quot;</span>
386
387<span class="n">singlehtml:</span>
388        <span class="nv">$</span><span class="err">(</span><span class="nv">SPHINXBUILD</span><span class="p">)</span> <span class="o">-</span><span class="n">b</span> <span class="n">singlehtml</span> <span class="nv">$</span><span class="err">(</span><span class="nv">ALLSPHINXOPTS</span><span class="p">)</span> <span class="nv">$</span><span class="err">(</span><span class="nv">BUILDDIR</span><span class="p">)</span><span class="o">/</span><span class="n">singlehtml</span>
389        <span class="nv">@echo</span>
390        <span class="nv">@echo</span> <span class="s">&quot;Build finished. The HTML page is in $(BUILDDIR)/singlehtml.&quot;</span>
391
392<span class="n">pickle:</span>
393        <span class="nv">$</span><span class="err">(</span><span class="nv">SPHINXBUILD</span><span class="p">)</span> <span class="o">-</span><span class="n">b</span> <span class="n">pickle</span> <span class="nv">$</span><span class="err">(</span><span class="nv">ALLSPHINXOPTS</span><span class="p">)</span> <span class="nv">$</span><span class="err">(</span><span class="nv">BUILDDIR</span><span class="p">)</span><span class="o">/</span><span class="n">pickle</span>
394        <span class="nv">@echo</span>
395        <span class="nv">@echo</span> <span class="s">&quot;Build finished; now you can process the pickle files.&quot;</span>
396
397<span class="n">json:</span>
398        <span class="nv">$</span><span class="err">(</span><span class="nv">SPHINXBUILD</span><span class="p">)</span> <span class="o">-</span><span class="n">b</span> <span class="n">json</span> <span class="nv">$</span><span class="err">(</span><span class="nv">ALLSPHINXOPTS</span><span class="p">)</span> <span class="nv">$</span><span class="err">(</span><span class="nv">BUILDDIR</span><span class="p">)</span><span class="o">/</span><span class="n">json</span>
399        <span class="nv">@echo</span>
400        <span class="nv">@echo</span> <span class="s">&quot;Build finished; now you can process the JSON files.&quot;</span>
401
402<span class="n">htmlhelp:</span>
403        <span class="nv">$</span><span class="err">(</span><span class="nv">SPHINXBUILD</span><span class="p">)</span> <span class="o">-</span><span class="n">b</span> <span class="n">htmlhelp</span> <span class="nv">$</span><span class="err">(</span><span class="nv">ALLSPHINXOPTS</span><span class="p">)</span> <span class="nv">$</span><span class="err">(</span><span class="nv">BUILDDIR</span><span class="p">)</span><span class="o">/</span><span class="n">htmlhelp</span>
404        <span class="nv">@echo</span>
405        <span class="nv">@echo</span> <span class="s">&quot;Build finished; now you can run HTML Help Workshop with the&quot;</span> <span class="o">\</span>
406              <span class="s">&quot;.hhp project file in $(BUILDDIR)/htmlhelp.&quot;</span>
407
408<span class="n">qthelp:</span>
409        <span class="nv">$</span><span class="err">(</span><span class="nv">SPHINXBUILD</span><span class="p">)</span> <span class="o">-</span><span class="n">b</span> <span class="n">qthelp</span> <span class="nv">$</span><span class="err">(</span><span class="nv">ALLSPHINXOPTS</span><span class="p">)</span> <span class="nv">$</span><span class="err">(</span><span class="nv">BUILDDIR</span><span class="p">)</span><span class="o">/</span><span class="n">qthelp</span>
410        <span class="nv">@echo</span>
411        <span class="nv">@echo</span> <span class="s">&quot;Build finished; now you can run &quot;</span><span class="n">qcollectiongenerator</span><span class="s">&quot; with the&quot;</span> <span class="o">\</span>
412              <span class="s">&quot;.qhcp project file in $(BUILDDIR)/qthelp, like this:&quot;</span>
413        <span class="nv">@echo</span> <span class="s">&quot;# qcollectiongenerator $(BUILDDIR)/qthelp/pulse_train.qhcp&quot;</span>
414        <span class="nv">@echo</span> <span class="s">&quot;To view the help file:&quot;</span>
415        <span class="nv">@echo</span> <span class="s">&quot;# assistant -collectionFile $(BUILDDIR)/qthelp/pulse_train.qhc&quot;</span>
416
417<span class="n">devhelp:</span>
418        <span class="nv">$</span><span class="err">(</span><span class="nv">SPHINXBUILD</span><span class="p">)</span> <span class="o">-</span><span class="n">b</span> <span class="n">devhelp</span> <span class="nv">$</span><span class="err">(</span><span class="nv">ALLSPHINXOPTS</span><span class="p">)</span> <span class="nv">$</span><span class="err">(</span><span class="nv">BUILDDIR</span><span class="p">)</span><span class="o">/</span><span class="n">devhelp</span>
419        <span class="nv">@echo</span>
420        <span class="nv">@echo</span> <span class="s">&quot;Build finished.&quot;</span>
421        <span class="nv">@echo</span> <span class="s">&quot;To view the help file:&quot;</span>
422        <span class="nv">@echo</span> <span class="s">&quot;# mkdir -p $$HOME/.local/share/devhelp/pulse_train&quot;</span>
423        <span class="nv">@echo</span> <span class="s">&quot;# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pulse_train&quot;</span>
424        <span class="nv">@echo</span> <span class="s">&quot;# devhelp&quot;</span>
425
426<span class="n">epub:</span>
427        <span class="nv">$</span><span class="err">(</span><span class="nv">SPHINXBUILD</span><span class="p">)</span> <span class="o">-</span><span class="n">b</span> <span class="n">epub</span> <span class="nv">$</span><span class="err">(</span><span class="nv">ALLSPHINXOPTS</span><span class="p">)</span> <span class="nv">$</span><span class="err">(</span><span class="nv">BUILDDIR</span><span class="p">)</span><span class="o">/</span><span class="n">epub</span>
428        <span class="nv">@echo</span>
429        <span class="nv">@echo</span> <span class="s">&quot;Build finished. The epub file is in $(BUILDDIR)/epub.&quot;</span>
430
431<span class="n">latex:</span>
432        <span class="nv">$</span><span class="err">(</span><span class="nv">SPHINXBUILD</span><span class="p">)</span> <span class="o">-</span><span class="n">b</span> <span class="n">latex</span> <span class="nv">$</span><span class="err">(</span><span class="nv">ALLSPHINXOPTS</span><span class="p">)</span> <span class="nv">$</span><span class="err">(</span><span class="nv">BUILDDIR</span><span class="p">)</span><span class="o">/</span><span class="n">latex</span>
433        <span class="nv">@echo</span>
434        <span class="nv">@echo</span> <span class="s">&quot;Build finished; the LaTeX files are in $(BUILDDIR)/latex.&quot;</span>
435        <span class="nv">@echo</span> <span class="s">&quot;Run \`make&#39; in that directory to run these through (pdf)latex&quot;</span> <span class="o">\</span>
436              <span class="s">&quot;(use \`make latexpdf&#39; here to do that automatically).&quot;</span>
437
438<span class="n">latexpdf:</span>
439        <span class="nv">$</span><span class="err">(</span><span class="nv">SPHINXBUILD</span><span class="p">)</span> <span class="o">-</span><span class="n">b</span> <span class="n">latex</span> <span class="nv">$</span><span class="err">(</span><span class="nv">ALLSPHINXOPTS</span><span class="p">)</span> <span class="nv">$</span><span class="err">(</span><span class="nv">BUILDDIR</span><span class="p">)</span><span class="o">/</span><span class="n">latex</span>
440        <span class="nv">@echo</span> <span class="s">&quot;Running LaTeX files through pdflatex...&quot;</span>
441        <span class="nv">$</span><span class="err">(</span><span class="nv">MAKE</span><span class="p">)</span> <span class="o">-</span><span class="n">C</span> <span class="nv">$</span><span class="err">(</span><span class="nv">BUILDDIR</span><span class="p">)</span><span class="o">/</span><span class="n">latex</span> <span class="n">all</span><span class="o">-</span><span class="n">pdf</span>
442        <span class="nv">@echo</span> <span class="s">&quot;pdflatex finished; the PDF files are in $(BUILDDIR)/latex.&quot;</span>
443
444<span class="n">text:</span>
445        <span class="nv">$</span><span class="err">(</span><span class="nv">SPHINXBUILD</span><span class="p">)</span> <span class="o">-</span><span class="n">b</span> <span class="n">text</span> <span class="nv">$</span><span class="err">(</span><span class="nv">ALLSPHINXOPTS</span><span class="p">)</span> <span class="nv">$</span><span class="err">(</span><span class="nv">BUILDDIR</span><span class="p">)</span><span class="o">/</span><span class="n">text</span>
446        <span class="nv">@echo</span>
447        <span class="nv">@echo</span> <span class="s">&quot;Build finished. The text files are in $(BUILDDIR)/text.&quot;</span>
448
449<span class="n">man:</span>
450        <span class="nv">$</span><span class="err">(</span><span class="nv">SPHINXBUILD</span><span class="p">)</span> <span class="o">-</span><span class="n">b</span> <span class="n">man</span> <span class="nv">$</span><span class="err">(</span><span class="nv">ALLSPHINXOPTS</span><span class="p">)</span> <span class="nv">$</span><span class="err">(</span><span class="nv">BUILDDIR</span><span class="p">)</span><span class="o">/</span><span class="n">man</span>
451        <span class="nv">@echo</span>
452        <span class="nv">@echo</span> <span class="s">&quot;Build finished. The manual pages are in $(BUILDDIR)/man.&quot;</span>
453
454<span class="n">texinfo:</span>
455        <span class="nv">$</span><span class="err">(</span><span class="nv">SPHINXBUILD</span><span class="p">)</span> <span class="o">-</span><span class="n">b</span> <span class="n">texinfo</span> <span class="nv">$</span><span class="err">(</span><span class="nv">ALLSPHINXOPTS</span><span class="p">)</span> <span class="nv">$</span><span class="err">(</span><span class="nv">BUILDDIR</span><span class="p">)</span><span class="o">/</span><span class="n">texinfo</span>
456        <span class="nv">@echo</span>
457        <span class="nv">@echo</span> <span class="s">&quot;Build finished. The Texinfo files are in $(BUILDDIR)/texinfo.&quot;</span>
458        <span class="nv">@echo</span> <span class="s">&quot;Run \`make&#39; in that directory to run these through makeinfo&quot;</span> <span class="o">\</span>
459              <span class="s">&quot;(use \`make info&#39; here to do that automatically).&quot;</span>
460
461<span class="n">info:</span>
462        <span class="nv">$</span><span class="err">(</span><span class="nv">SPHINXBUILD</span><span class="p">)</span> <span class="o">-</span><span class="n">b</span> <span class="n">texinfo</span> <span class="nv">$</span><span class="err">(</span><span class="nv">ALLSPHINXOPTS</span><span class="p">)</span> <span class="nv">$</span><span class="err">(</span><span class="nv">BUILDDIR</span><span class="p">)</span><span class="o">/</span><span class="n">texinfo</span>
463        <span class="nv">@echo</span> <span class="s">&quot;Running Texinfo files through makeinfo...&quot;</span>
464        <span class="n">make</span> <span class="o">-</span><span class="n">C</span> <span class="nv">$</span><span class="err">(</span><span class="nv">BUILDDIR</span><span class="p">)</span><span class="o">/</span><span class="n">texinfo</span> <span class="n">info</span>
465        <span class="nv">@echo</span> <span class="s">&quot;makeinfo finished; the Info files are in $(BUILDDIR)/texinfo.&quot;</span>
466
467<span class="n">gettext:</span>
468        <span class="nv">$</span><span class="err">(</span><span class="nv">SPHINXBUILD</span><span class="p">)</span> <span class="o">-</span><span class="n">b</span> <span class="n">gettext</span> <span class="nv">$</span><span class="err">(</span><span class="nv">I18NSPHINXOPTS</span><span class="p">)</span> <span class="nv">$</span><span class="err">(</span><span class="nv">BUILDDIR</span><span class="p">)</span><span class="o">/</span><span class="n">locale</span>
469        <span class="nv">@echo</span>
470        <span class="nv">@echo</span> <span class="s">&quot;Build finished. The message catalogs are in $(BUILDDIR)/locale.&quot;</span>
471
472<span class="n">changes:</span>
473        <span class="nv">$</span><span class="err">(</span><span class="nv">SPHINXBUILD</span><span class="p">)</span> <span class="o">-</span><span class="n">b</span> <span class="n">changes</span> <span class="nv">$</span><span class="err">(</span><span class="nv">ALLSPHINXOPTS</span><span class="p">)</span> <span class="nv">$</span><span class="err">(</span><span class="nv">BUILDDIR</span><span class="p">)</span><span class="o">/</span><span class="n">changes</span>
474        <span class="nv">@echo</span>
475        <span class="nv">@echo</span> <span class="s">&quot;The overview file is in $(BUILDDIR)/changes.&quot;</span>
476
477<span class="n">linkcheck:</span>
478        <span class="nv">$</span><span class="err">(</span><span class="nv">SPHINXBUILD</span><span class="p">)</span> <span class="o">-</span><span class="n">b</span> <span class="n">linkcheck</span> <span class="nv">$</span><span class="err">(</span><span class="nv">ALLSPHINXOPTS</span><span class="p">)</span> <span class="nv">$</span><span class="err">(</span><span class="nv">BUILDDIR</span><span class="p">)</span><span class="o">/</span><span class="n">linkcheck</span>
479        <span class="nv">@echo</span>
480        <span class="nv">@echo</span> <span class="s">&quot;Link check complete; look for any errors in the above output &quot;</span> <span class="o">\</span>
481              <span class="s">&quot;or in $(BUILDDIR)/linkcheck/output.txt.&quot;</span>
482
483<span class="n">doctest:</span>
484        <span class="nv">$</span><span class="err">(</span><span class="nv">SPHINXBUILD</span><span class="p">)</span> <span class="o">-</span><span class="n">b</span> <span class="n">doctest</span> <span class="nv">$</span><span class="err">(</span><span class="nv">ALLSPHINXOPTS</span><span class="p">)</span> <span class="nv">$</span><span class="err">(</span><span class="nv">BUILDDIR</span><span class="p">)</span><span class="o">/</span><span class="n">doctest</span>
485        <span class="nv">@echo</span> <span class="s">&quot;Testing of doctests in the sources finished, look at the &quot;</span> <span class="o">\</span>
486              <span class="s">&quot;results in $(BUILDDIR)/doctest/output.txt.&quot;</span>
487</pre></div>
488</td></tr></table></div>
489<div class="section" id="indices-and-tables">
490<h4>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h4>
491<ul class="simple">
492<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
493<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
494</ul>
495</div>
496</div>
497</div>
498</div>
499
500
501          </div>
502        </div>
503      </div>
504      <div class="sphinxsidebar">
505        <div class="sphinxsidebarwrapper">
506  <h3><a href="index.html">Table Of Contents</a></h3>
507  <ul>
508<li><a class="reference internal" href="#">Coaching on the use of reStructuredText</a><ul>
509<li><a class="reference internal" href="#svn-export-this-example-documentation">SVN export this example documentation</a></li>
510<li><a class="reference internal" href="#example-1">Example 1</a></li>
511<li><a class="reference internal" href="#example-2">Example 2</a><ul>
512<li><a class="reference internal" href="#inline-code-external-code-and-other-literal-examples">inline code, external code, and other literal examples</a></li>
513<li><a class="reference internal" href="#unix-makefile">UNIX Makefile</a><ul>
514<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
515</ul>
516</li>
517</ul>
518</li>
519</ul>
520</li>
521</ul>
522
523  <h4>Previous topic</h4>
524  <p class="topless"><a href="index.html"
525                        title="previous chapter">Documentation of Programmable pulse train</a></p>
526  <h3>This Page</h3>
527  <ul class="this-page-menu">
528    <li><a href="_sources/coaching1.txt"
529           rel="nofollow">Show Source</a></li>
530  </ul>
531<div id="searchbox" style="display: none">
532  <h3>Quick search</h3>
533    <form class="search" action="search.html" method="get">
534      <input type="text" name="q" />
535      <input type="submit" value="Go" />
536      <input type="hidden" name="check_keywords" value="yes" />
537      <input type="hidden" name="area" value="default" />
538    </form>
539    <p class="searchtip" style="font-size: 90%">
540    Enter search terms or a module, class or function name.
541    </p>
542</div>
543<script type="text/javascript">$('#searchbox').show(0);</script>
544        </div>
545      </div>
546      <div class="clearer"></div>
547    </div>
548    <div class="related">
549      <h3>Navigation</h3>
550      <ul>
551        <li class="right" style="margin-right: 10px">
552          <a href="genindex.html" title="General Index"
553             >index</a></li>
554        <li class="right" >
555          <a href="index.html" title="Documentation of Programmable pulse train"
556             >previous</a> |</li>
557        <li><a href="index.html">pulse_train 2012-06 documentation</a> &raquo;</li> 
558      </ul>
559    </div>
560    <div class="footer">
561        &copy; Copyright 2012, Kurt Goetze, BCDA.
562      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
563    </div>
564  </body>
565</html>
Note: See TracBrowser for help on using the repository browser.