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

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

OK, good enough for now

  • Property svn:mime-type set to text/html
File size: 31.3 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. <a class="footnote-reference" href="#id2" id="id1">[1]</a>
58It is easy to edit the documentation since it is text.  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">sphinxdoc</span></tt> (or whatever you name it) 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<table class="docutils footnote" frame="void" id="id2" rules="none">
69<colgroup><col class="label" /><col /></colgroup>
70<tbody valign="top">
71<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td>Sphinx uses Python.  You may want to build this on an APS
72SunOS or linux computer.  If so, you&#8217;ll need to make sure
73that the <tt class="docutils literal"><span class="pre">/APSshare/epd/{architecture_choice}/bin</span></tt> directory
74is on your executable path.</td></tr>
75</tbody>
76</table>
77<div class="section" id="svn-export-this-example-documentation">
78<h2>SVN export this example documentation<a class="headerlink" href="#svn-export-this-example-documentation" title="Permalink to this headline">¶</a></h2>
79<p>You can pull this example from its subversion repo and add it
80to your project by going to the desired directory
81(perhaps the TOP directory for your support) and exporting from this
82subversion repository:</p>
83<div class="highlight-python"><pre>svn export http://subversion.xor.aps.anl.gov/bcdaext/pulse_train_doc sphinxdoc</pre>
84</div>
85</div>
86<div class="section" id="example-1">
87<h2>Example 1<a class="headerlink" href="#example-1" title="Permalink to this headline">¶</a></h2>
88<p>Here is some more text.</p>
89<blockquote>
90<div>This text is an inset.</div></blockquote>
91</div>
92<div class="section" id="example-2">
93<h2>Example 2<a class="headerlink" href="#example-2" title="Permalink to this headline">¶</a></h2>
94<p>Tell about example 2.</p>
95<div class="section" id="inline-code-external-code-and-other-literal-examples">
96<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>
97<p>Use a different underline symbol for each section <span class="target" id="index-2"></span>level.  To use
98<tt class="docutils literal"><span class="pre">literal</span> <span class="pre">text</span></tt>, surround test with double backticks or end a paragraph
99with a double colon:</p>
100<div class="highlight-python"><pre>place a blank line
101then indent the text to be made to look like a program</pre>
102</div>
103<p>It is possible to include all or even part of code files in
104any accessible directory.</p>
105<div class="highlight-guess"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1
1062</pre></div></td><td class="code"><div class="highlight"><pre><span class="c1"># this is some example C code</span>
107<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>
108</pre></div>
109</td></tr></table></div>
110<div class="highlight-guess"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre> 1
111 2
112 3
113 4
114 5
115 6
116 7
117 8
118 9
11910
12011
12112
12213
12314
12415
12516
12617
12718
12819
12920
13021
13122
13223
13324
13425
13526
13627
13728
13829
13930
14031
14132
14233
14334
14435
14536</pre></div></td><td class="code"><div class="highlight"><pre><span class="cp">.. $Id: index.rst 863 2012-06-05 07:20:49Z jemian $</span>
146
147<span class="gh">===========================================</span>
148<span class="gh">Documentation of Programmable pulse train</span>
149<span class="gh">===========================================</span>
150
151<span class="p">..</span> <span class="ow">figure</span><span class="p">::</span> adl_screens.png
152
153   the figure caption says &quot;Three MEDM screens&quot;
154
155<span class="cp">.. this is a bit fancier for a figure, using a table </span>
156   to get a fancier title bar since the figure caption
157   above looks very plain.
158
159+-----------------+------------------------------+
160<span class="o">|</span> This table is actually a Figure!               |
161+=================+==============================+
162<span class="o">|</span>  Dff Q output:  |  .. image:: square_wave.png  |
163+-----------------+------------------------------+
164
165
166
167
168Contents:
169
170<span class="p">..</span> <span class="ow">toctree</span><span class="p">::</span>
171   <span class="nc">:maxdepth:</span> <span class="nf">3</span>
172   <span class="nc">:glob:</span>
173   
174   coaching*
175
176<span class="gh">Indices and tables</span>
177<span class="gh">==================</span>
178
179<span class="m">*</span> <span class="na">:ref:</span><span class="nv">`genindex`</span>
180<span class="m">*</span> <span class="na">:ref:</span><span class="nv">`search`</span>
181</pre></div>
182</td></tr></table></div>
183<div class="admonition note">
184<p class="first admonition-title">Note</p>
185<p class="last">More <span class="target" id="index-3"></span>help is available from the sphinx
186link (<a class="reference external" href="http://sphinx.pocoo.org/">http://sphinx.pocoo.org/</a>) at the bottom of this web page.</p>
187</div>
188</div>
189<div class="section" id="unix-makefile">
190<h3>UNIX Makefile<a class="headerlink" href="#unix-makefile" title="Permalink to this headline">¶</a></h3>
191<div class="highlight-guess"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>  1
192  2
193  3
194  4
195  5
196  6
197  7
198  8
199  9
200 10
201 11
202 12
203 13
204 14
205 15
206 16
207 17
208 18
209 19
210 20
211 21
212 22
213 23
214 24
215 25
216 26
217 27
218 28
219 29
220 30
221 31
222 32
223 33
224 34
225 35
226 36
227 37
228 38
229 39
230 40
231 41
232 42
233 43
234 44
235 45
236 46
237 47
238 48
239 49
240 50
241 51
242 52
243 53
244 54
245 55
246 56
247 57
248 58
249 59
250 60
251 61
252 62
253 63
254 64
255 65
256 66
257 67
258 68
259 69
260 70
261 71
262 72
263 73
264 74
265 75
266 76
267 77
268 78
269 79
270 80
271 81
272 82
273 83
274 84
275 85
276 86
277 87
278 88
279 89
280 90
281 91
282 92
283 93
284 94
285 95
286 96
287 97
288 98
289 99
290100
291101
292102
293103
294104
295105
296106
297107
298108
299109
300110
301111
302112
303113
304114
305115
306116
307117
308118
309119
310120
311121
312122
313123
314124
315125
316126
317127
318128
319129
320130
321131
322132
323133
324134
325135
326136
327137
328138
329139
330140
331141
332142
333143
334144
335145
336146
337147
338148
339149
340150
341151
342152
343153</pre></div></td><td class="code"><div class="highlight"><pre><span class="c1"># Makefile for Sphinx documentation</span>
344<span class="c1">#</span>
345
346<span class="c1"># You can set these variables from the command line.</span>
347<span class="n">SPHINXOPTS</span>    <span class="o">=</span>
348<span class="n">SPHINXBUILD</span>   <span class="o">=</span> <span class="n">sphinx</span><span class="o">-</span><span class="n">build</span>
349<span class="n">PAPER</span>         <span class="o">=</span>
350<span class="n">BUILDDIR</span>      <span class="o">=</span> <span class="n">build</span>
351
352<span class="c1"># Internal variables.</span>
353<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>
354<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>
355<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>
356<span class="c1"># the i18n builder cannot share the environment and doctrees with the others</span>
357<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>
358
359<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>
360
361<span class="n">help:</span>
362        <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>
363        <span class="nv">@echo</span> <span class="s">&quot;  html       to make standalone HTML files&quot;</span>
364        <span class="nv">@echo</span> <span class="s">&quot;  dirhtml    to make HTML files named index.html in directories&quot;</span>
365        <span class="nv">@echo</span> <span class="s">&quot;  singlehtml to make a single large HTML file&quot;</span>
366        <span class="nv">@echo</span> <span class="s">&quot;  pickle     to make pickle files&quot;</span>
367        <span class="nv">@echo</span> <span class="s">&quot;  json       to make JSON files&quot;</span>
368        <span class="nv">@echo</span> <span class="s">&quot;  htmlhelp   to make HTML files and a HTML help project&quot;</span>
369        <span class="nv">@echo</span> <span class="s">&quot;  qthelp     to make HTML files and a qthelp project&quot;</span>
370        <span class="nv">@echo</span> <span class="s">&quot;  devhelp    to make HTML files and a Devhelp project&quot;</span>
371        <span class="nv">@echo</span> <span class="s">&quot;  epub       to make an epub&quot;</span>
372        <span class="nv">@echo</span> <span class="s">&quot;  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter&quot;</span>
373        <span class="nv">@echo</span> <span class="s">&quot;  latexpdf   to make LaTeX files and run them through pdflatex&quot;</span>
374        <span class="nv">@echo</span> <span class="s">&quot;  text       to make text files&quot;</span>
375        <span class="nv">@echo</span> <span class="s">&quot;  man        to make manual pages&quot;</span>
376        <span class="nv">@echo</span> <span class="s">&quot;  texinfo    to make Texinfo files&quot;</span>
377        <span class="nv">@echo</span> <span class="s">&quot;  info       to make Texinfo files and run them through makeinfo&quot;</span>
378        <span class="nv">@echo</span> <span class="s">&quot;  gettext    to make PO message catalogs&quot;</span>
379        <span class="nv">@echo</span> <span class="s">&quot;  changes    to make an overview of all changed/added/deprecated items&quot;</span>
380        <span class="nv">@echo</span> <span class="s">&quot;  linkcheck  to check all external links for integrity&quot;</span>
381        <span class="nv">@echo</span> <span class="s">&quot;  doctest    to run all doctests embedded in the documentation (if enabled)&quot;</span>
382
383<span class="n">clean:</span>
384        <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>
385
386<span class="n">html:</span>
387        <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>
388        <span class="nv">@echo</span>
389        <span class="nv">@echo</span> <span class="s">&quot;Build finished. The HTML pages are in $(BUILDDIR)/html.&quot;</span>
390
391<span class="n">dirhtml:</span>
392        <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>
393        <span class="nv">@echo</span>
394        <span class="nv">@echo</span> <span class="s">&quot;Build finished. The HTML pages are in $(BUILDDIR)/dirhtml.&quot;</span>
395
396<span class="n">singlehtml:</span>
397        <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>
398        <span class="nv">@echo</span>
399        <span class="nv">@echo</span> <span class="s">&quot;Build finished. The HTML page is in $(BUILDDIR)/singlehtml.&quot;</span>
400
401<span class="n">pickle:</span>
402        <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>
403        <span class="nv">@echo</span>
404        <span class="nv">@echo</span> <span class="s">&quot;Build finished; now you can process the pickle files.&quot;</span>
405
406<span class="n">json:</span>
407        <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>
408        <span class="nv">@echo</span>
409        <span class="nv">@echo</span> <span class="s">&quot;Build finished; now you can process the JSON files.&quot;</span>
410
411<span class="n">htmlhelp:</span>
412        <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>
413        <span class="nv">@echo</span>
414        <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>
415              <span class="s">&quot;.hhp project file in $(BUILDDIR)/htmlhelp.&quot;</span>
416
417<span class="n">qthelp:</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">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>
419        <span class="nv">@echo</span>
420        <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>
421              <span class="s">&quot;.qhcp project file in $(BUILDDIR)/qthelp, like this:&quot;</span>
422        <span class="nv">@echo</span> <span class="s">&quot;# qcollectiongenerator $(BUILDDIR)/qthelp/pulse_train.qhcp&quot;</span>
423        <span class="nv">@echo</span> <span class="s">&quot;To view the help file:&quot;</span>
424        <span class="nv">@echo</span> <span class="s">&quot;# assistant -collectionFile $(BUILDDIR)/qthelp/pulse_train.qhc&quot;</span>
425
426<span class="n">devhelp:</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">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>
428        <span class="nv">@echo</span>
429        <span class="nv">@echo</span> <span class="s">&quot;Build finished.&quot;</span>
430        <span class="nv">@echo</span> <span class="s">&quot;To view the help file:&quot;</span>
431        <span class="nv">@echo</span> <span class="s">&quot;# mkdir -p $$HOME/.local/share/devhelp/pulse_train&quot;</span>
432        <span class="nv">@echo</span> <span class="s">&quot;# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pulse_train&quot;</span>
433        <span class="nv">@echo</span> <span class="s">&quot;# devhelp&quot;</span>
434
435<span class="n">epub:</span>
436        <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>
437        <span class="nv">@echo</span>
438        <span class="nv">@echo</span> <span class="s">&quot;Build finished. The epub file is in $(BUILDDIR)/epub.&quot;</span>
439
440<span class="n">latex:</span>
441        <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>
442        <span class="nv">@echo</span>
443        <span class="nv">@echo</span> <span class="s">&quot;Build finished; the LaTeX files are in $(BUILDDIR)/latex.&quot;</span>
444        <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>
445              <span class="s">&quot;(use \`make latexpdf&#39; here to do that automatically).&quot;</span>
446
447<span class="n">latexpdf:</span>
448        <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>
449        <span class="nv">@echo</span> <span class="s">&quot;Running LaTeX files through pdflatex...&quot;</span>
450        <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>
451        <span class="nv">@echo</span> <span class="s">&quot;pdflatex finished; the PDF files are in $(BUILDDIR)/latex.&quot;</span>
452
453<span class="n">text:</span>
454        <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>
455        <span class="nv">@echo</span>
456        <span class="nv">@echo</span> <span class="s">&quot;Build finished. The text files are in $(BUILDDIR)/text.&quot;</span>
457
458<span class="n">man:</span>
459        <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>
460        <span class="nv">@echo</span>
461        <span class="nv">@echo</span> <span class="s">&quot;Build finished. The manual pages are in $(BUILDDIR)/man.&quot;</span>
462
463<span class="n">texinfo:</span>
464        <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>
465        <span class="nv">@echo</span>
466        <span class="nv">@echo</span> <span class="s">&quot;Build finished. The Texinfo files are in $(BUILDDIR)/texinfo.&quot;</span>
467        <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>
468              <span class="s">&quot;(use \`make info&#39; here to do that automatically).&quot;</span>
469
470<span class="n">info:</span>
471        <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>
472        <span class="nv">@echo</span> <span class="s">&quot;Running Texinfo files through makeinfo...&quot;</span>
473        <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>
474        <span class="nv">@echo</span> <span class="s">&quot;makeinfo finished; the Info files are in $(BUILDDIR)/texinfo.&quot;</span>
475
476<span class="n">gettext:</span>
477        <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>
478        <span class="nv">@echo</span>
479        <span class="nv">@echo</span> <span class="s">&quot;Build finished. The message catalogs are in $(BUILDDIR)/locale.&quot;</span>
480
481<span class="n">changes:</span>
482        <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>
483        <span class="nv">@echo</span>
484        <span class="nv">@echo</span> <span class="s">&quot;The overview file is in $(BUILDDIR)/changes.&quot;</span>
485
486<span class="n">linkcheck:</span>
487        <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>
488        <span class="nv">@echo</span>
489        <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>
490              <span class="s">&quot;or in $(BUILDDIR)/linkcheck/output.txt.&quot;</span>
491
492<span class="n">doctest:</span>
493        <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>
494        <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>
495              <span class="s">&quot;results in $(BUILDDIR)/doctest/output.txt.&quot;</span>
496</pre></div>
497</td></tr></table></div>
498<div class="section" id="indices-and-tables">
499<h4>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h4>
500<ul class="simple">
501<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
502<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
503</ul>
504</div>
505</div>
506</div>
507</div>
508
509
510          </div>
511        </div>
512      </div>
513      <div class="sphinxsidebar">
514        <div class="sphinxsidebarwrapper">
515  <h3><a href="index.html">Table Of Contents</a></h3>
516  <ul>
517<li><a class="reference internal" href="#">Coaching on the use of reStructuredText</a><ul>
518<li><a class="reference internal" href="#svn-export-this-example-documentation">SVN export this example documentation</a></li>
519<li><a class="reference internal" href="#example-1">Example 1</a></li>
520<li><a class="reference internal" href="#example-2">Example 2</a><ul>
521<li><a class="reference internal" href="#inline-code-external-code-and-other-literal-examples">inline code, external code, and other literal examples</a></li>
522<li><a class="reference internal" href="#unix-makefile">UNIX Makefile</a><ul>
523<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
524</ul>
525</li>
526</ul>
527</li>
528</ul>
529</li>
530</ul>
531
532  <h4>Previous topic</h4>
533  <p class="topless"><a href="index.html"
534                        title="previous chapter">Documentation of Programmable pulse train</a></p>
535  <h3>This Page</h3>
536  <ul class="this-page-menu">
537    <li><a href="_sources/coaching1.txt"
538           rel="nofollow">Show Source</a></li>
539  </ul>
540<div id="searchbox" style="display: none">
541  <h3>Quick search</h3>
542    <form class="search" action="search.html" method="get">
543      <input type="text" name="q" />
544      <input type="submit" value="Go" />
545      <input type="hidden" name="check_keywords" value="yes" />
546      <input type="hidden" name="area" value="default" />
547    </form>
548    <p class="searchtip" style="font-size: 90%">
549    Enter search terms or a module, class or function name.
550    </p>
551</div>
552<script type="text/javascript">$('#searchbox').show(0);</script>
553        </div>
554      </div>
555      <div class="clearer"></div>
556    </div>
557    <div class="related">
558      <h3>Navigation</h3>
559      <ul>
560        <li class="right" style="margin-right: 10px">
561          <a href="genindex.html" title="General Index"
562             >index</a></li>
563        <li class="right" >
564          <a href="index.html" title="Documentation of Programmable pulse train"
565             >previous</a> |</li>
566        <li><a href="index.html">pulse_train 2012-06 documentation</a> &raquo;</li> 
567      </ul>
568    </div>
569    <div class="footer">
570        &copy; Copyright 2012, Kurt Goetze, BCDA.
571      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
572    </div>
573  </body>
574</html>
Note: See TracBrowser for help on using the repository browser.