Ignore:
Timestamp:
Jun 5, 2012 2:29:12 AM (10 years ago)
Author:
jemian
Message:

OK, good enough for now

File:
1 edited

Legend:

Unmodified
Added
Removed
  • pulse_train_doc/build/html/coaching1.html

    r864 r865  
    5555<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>
    5656</div>
    57 <p>This is a just an example of writing the documentation using sphinx.
    58 It is easy.  You can find the built <span class="target" id="index-0"></span>html documentation in
     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
    5959<tt class="docutils literal"><span class="pre">build/html/index.html</span></tt>.  To build the documentation, you need to
    60 be in the <tt class="docutils literal"><span class="pre">doc</span></tt> directory, then type:</p>
     60be in the <tt class="docutils literal"><span class="pre">sphinxdoc</span></tt> (or whatever you name it) directory, then type:</p>
    6161<div class="highlight-python"><pre>make html</pre>
    6262</div>
     
    6666make html</pre>
    6767</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>
    6877<div class="section" id="svn-export-this-example-documentation">
    6978<h2>SVN export this example documentation<a class="headerlink" href="#svn-export-this-example-documentation" title="Permalink to this headline">¶</a></h2>
     
    13414334
    13514435
    136 36</pre></div></td><td class="code"><div class="highlight"><pre><span class="cp">.. $Id: $</span>
     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>
    137146
    138147<span class="gh">===========================================</span>
Note: See TracChangeset for help on using the changeset viewer.