Changeset 923


Ignore:
Timestamp:
Jun 13, 2012 12:11:59 PM (10 years ago)
Author:
jemian
Message:

tweaked the instructions for publishing from the SVN server

Location:
softGlue_examples
Files:
15 edited

Legend:

Unmodified
Added
Removed
  • softGlue_examples/Makefile

    r863 r923  
    4040
    4141clean:
    42         -rm -rf $(BUILDDIR)/*
     42        #-rm -rf $(BUILDDIR)/*
     43        -rm -rf $(BUILDDIR)/doctrees
    4344
    4445html:
  • softGlue_examples/build/html/_sources/adding_examples.txt

    r879 r923  
    2727++++++++++++++++++++++++++++++++++++++++++
    2828
    29 =========  ===============================================
     29=========  ========================================
    3030extension  command
    31 =========  ===============================================
     31=========  ========================================
    3232``.html``  ``svn ps svn:mime-type text/html``
    3333``.css``   ``svn ps svn:mime-type text/css``
    3434``.js``    ``svn ps svn:mime-type text/javascript``
    35 =========  ===============================================
     35=========  ========================================
    3636
    37 Any of these commands may be useful at times when adding
     37Publishing new content as HTML
     38++++++++++++++++++++++++++++++
     39
     40The subversion repository also can act as a WWW server.
     41It is possible to publish the built HTML documentatiojn
     42as a complete web site directly from the subversion server.
     43For this to happen, the built documentation needs to be added
     44to the subversion repository.  The MIME types of certain files
     45needs to be set properly so the SVN server can deliver them
     46identified in a way that WWW clients will render them properly.
     47
     48The commands below may be useful at times when adding
    3849new examples so the HTML files display properly from the
    3950subversion repository server::
    4051
    4152        cd {softGlue_examples}
     53       
     54        # these commands will add all built HTML content
     55        svn add build/html/*
     56        svn add build/html/*/*
     57        # -or-  (to be more selective as to what is published)
    4258        svn st -u
    43         svn add {any content from previous command with "?" in left column}
     59        svn add {any content from previous "svn st" command with "?" in left column}
     60       
     61        # Now, you need to set the MIME types properly
     62        # or the SVN server will display the pages unformatted.
    4463        svn ps svn:mime-type text/html build/html/*.html
    4564        svn ps svn:mime-type text/html build/html/*/*.html
     
    4766        svn ps svn:mime-type text/css build/html/_static/*.css
    4867
     68Advisory about ``make clean``
     69^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    4970
    50 .. note:: Web documentation available from the SVN server:
     71When a Sphinx web site is to be published from the SVN server,
     72it is important to avoid the use of ``make clean``.  The *clean*
     73procedure in the standard as-supplied Sphinx Makefile completely
     74removes all content under the ``build/``
     75subdirectory (including the ``build/html/.svn`` subdirectory)
     76and removes the subversion information necessary to republish the WWW site.
    5177
    52    https://subversion.xor.aps.anl.gov/bcdaext/softGlue_examples/build/html/index.html
     78Instead of ``make clean``, you can force a complete Sphinx rebuild
     79by removing the ``build/doctrees`` subdirectory.  Either edit
     80the Makefile accordingly (as has been done here) or use this command::
     81
     82   /bin/rm -rf build/doctrees
     83
     84On this modified Makefile, ``make clean`` should look like this::
     85
     86  [jemian@gov,286,softGlue_examples]$ make clean
     87  #-rm -rf build/*
     88  rm -rf build/doctrees
     89
     90
     91Restoring SVN ``build/html/.svn`` subdirectory
     92~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     93
     94If the ``build/html/.svn`` has been removed,
     95it can be easy to restore from the SVN repository.
     96Try these commands::
     97
     98   mv build build.modified
     99   svn update
     100   make html
     101
     102Once you are confident that things work the way they should,
     103you can remove the old ``build.modified`` directory::
     104
     105   /bin/rm -rf build.modified
     106
     107.. note:: This can still retain unused content in the ``build/html``
     108   subdirectory (only a problem for the few who browse the
     109   ``build/html`` subdirectory contents). 
     110   To completely rebuild the published web site), it
     111   may be necessary to remove the ``build/html`` subdirectory from the
     112   SVN repository, commit that change, rebuild the web site, then add
     113   the new ``build/html`` subdirectory back into SVN.
  • softGlue_examples/build/html/_sources/index.txt

    r879 r923  
    1 .. $Id: index.rst 878 2012-06-05 21:36:27Z jemian $
     1.. $Id: index.rst 915 2012-06-12 21:53:35Z mooney $
    22
    33======================================================
     
    1515
    1616
    17 Contents:
     17Contents
     18==================
    1819
    1920.. toctree::
     
    2122   
    2223   programmable_pulse_train/index
     24   gated_scaler/index
     25   pulse_burst/index
     26   delay_gen/index
     27   motor_accel_gate/index
    2328
    24 Additional Help:
     29URL for this documentation
     30++++++++++++++++++++++++++
     31
     32This documentation is published directly from the XSD SVN server:
     33
     34*  https://subversion.xray.aps.anl.gov/bcdaext/softGlue_examples/build/html/index.html
     35
     36Additional Help
     37==================
    2538
    2639.. toctree::
     
    3043   coaching
    3144
    32 Indices and tables
     45Index and Search
    3346==================
    3447
  • softGlue_examples/build/html/_sources/programmable_pulse_train/index.txt

    r873 r923  
    1 .. $Id: index.rst 872 2012-06-05 20:40:40Z jemian $
     1.. $Id: index.rst 922 2012-06-13 15:58:36Z jemian $
    22
    33========================
  • softGlue_examples/build/html/_static/basic.css

    r873 r923  
    8080}
    8181
    82 div.sphinxsidebar input[type="text"] {
     82div.sphinxsidebar #searchbox input[type="text"] {
    8383    width: 170px;
    8484}
    8585
    86 div.sphinxsidebar input[type="submit"] {
     86div.sphinxsidebar #searchbox input[type="submit"] {
    8787    width: 30px;
    8888}
  • softGlue_examples/build/html/adding_examples.html

    r879 r923  
    2828    <link rel="top" title="softglueexamples 2012-06 documentation" href="index.html" />
    2929    <link rel="next" title="Additional Coaching on the use of reStructuredText" href="coaching.html" />
    30     <link rel="prev" title="Programmable pulse train" href="programmable_pulse_train/index.html" />
     30    <link rel="prev" title="Motor accel/decel pulse gate" href="motor_accel_gate/index.html" />
    3131  </head>
    3232  <body>
     
    4141             accesskey="N">next</a> |</li>
    4242        <li class="right" >
    43           <a href="programmable_pulse_train/index.html" title="Programmable pulse train"
     43          <a href="motor_accel_gate/index.html" title="Motor accel/decel pulse gate"
    4444             accesskey="P">previous</a> |</li>
    4545        <li><a href="index.html">softglueexamples 2012-06 documentation</a> &raquo;</li>
     
    7777<table border="1" class="docutils">
    7878<colgroup>
    79 <col width="16%" />
    80 <col width="84%" />
     79<col width="18%" />
     80<col width="82%" />
    8181</colgroup>
    8282<thead valign="bottom">
     
    9797</tbody>
    9898</table>
    99 <p>Any of these commands may be useful at times when adding
     99</div>
     100<div class="section" id="publishing-new-content-as-html">
     101<h2>Publishing new content as HTML<a class="headerlink" href="#publishing-new-content-as-html" title="Permalink to this headline">¶</a></h2>
     102<p>The subversion repository also can act as a WWW server.
     103It is possible to publish the built HTML documentatiojn
     104as a complete web site directly from the subversion server.
     105For this to happen, the built documentation needs to be added
     106to the subversion repository.  The MIME types of certain files
     107needs to be set properly so the SVN server can deliver them
     108identified in a way that WWW clients will render them properly.</p>
     109<p>The commands below may be useful at times when adding
    100110new examples so the HTML files display properly from the
    101111subversion repository server:</p>
    102112<div class="highlight-python"><pre>cd {softGlue_examples}
     113
     114# these commands will add all built HTML content
     115svn add build/html/*
     116svn add build/html/*/*
     117# -or-  (to be more selective as to what is published)
    103118svn st -u
    104 svn add {any content from previous command with "?" in left column}
     119svn add {any content from previous "svn st" command with "?" in left column}
     120
     121# Now, you need to set the MIME types properly
     122# or the SVN server will display the pages unformatted.
    105123svn ps svn:mime-type text/html build/html/*.html
    106124svn ps svn:mime-type text/html build/html/*/*.html
     
    108126svn ps svn:mime-type text/css build/html/_static/*.css</pre>
    109127</div>
     128<div class="section" id="advisory-about-make-clean">
     129<h3>Advisory about <tt class="docutils literal"><span class="pre">make</span> <span class="pre">clean</span></tt><a class="headerlink" href="#advisory-about-make-clean" title="Permalink to this headline">¶</a></h3>
     130<p>When a Sphinx web site is to be published from the SVN server,
     131it is important to avoid the use of <tt class="docutils literal"><span class="pre">make</span> <span class="pre">clean</span></tt>.  The <em>clean</em>
     132procedure in the standard as-supplied Sphinx Makefile completely
     133removes all content under the <tt class="docutils literal"><span class="pre">build/</span></tt>
     134subdirectory (including the <tt class="docutils literal"><span class="pre">build/html/.svn</span></tt> subdirectory)
     135and removes the subversion information necessary to republish the WWW site.</p>
     136<p>Instead of <tt class="docutils literal"><span class="pre">make</span> <span class="pre">clean</span></tt>, you can force a complete Sphinx rebuild
     137by removing the <tt class="docutils literal"><span class="pre">build/doctrees</span></tt> subdirectory.  Either edit
     138the Makefile accordingly (as has been done here) or use this command:</p>
     139<div class="highlight-python"><pre>/bin/rm -rf build/doctrees</pre>
     140</div>
     141<p>On this modified Makefile, <tt class="docutils literal"><span class="pre">make</span> <span class="pre">clean</span></tt> should look like this:</p>
     142<div class="highlight-python"><pre>[jemian@gov,286,softGlue_examples]$ make clean
     143#-rm -rf build/*
     144rm -rf build/doctrees</pre>
     145</div>
     146<div class="section" id="restoring-svn-build-html-svn-subdirectory">
     147<h4>Restoring SVN <tt class="docutils literal"><span class="pre">build/html/.svn</span></tt> subdirectory<a class="headerlink" href="#restoring-svn-build-html-svn-subdirectory" title="Permalink to this headline">¶</a></h4>
     148<p>If the <tt class="docutils literal"><span class="pre">build/html/.svn</span></tt> has been removed,
     149it can be easy to restore from the SVN repository.
     150Try these commands:</p>
     151<div class="highlight-python"><pre>mv build build.modified
     152svn update
     153make html</pre>
     154</div>
     155<p>Once you are confident that things work the way they should,
     156you can remove the old <tt class="docutils literal"><span class="pre">build.modified</span></tt> directory:</p>
     157<div class="highlight-python"><pre>/bin/rm -rf build.modified</pre>
     158</div>
    110159<div class="admonition note">
    111160<p class="first admonition-title">Note</p>
    112 <p>Web documentation available from the SVN server:</p>
    113 <p class="last"><a class="reference external" href="https://subversion.xor.aps.anl.gov/bcdaext/softGlue_examples/build/html/index.html">https://subversion.xor.aps.anl.gov/bcdaext/softGlue_examples/build/html/index.html</a></p>
     161<p class="last">This can still retain unused content in the <tt class="docutils literal"><span class="pre">build/html</span></tt>
     162subdirectory (only a problem for the few who browse the
     163<tt class="docutils literal"><span class="pre">build/html</span></tt> subdirectory contents).
     164To completely rebuild the published web site), it
     165may be necessary to remove the <tt class="docutils literal"><span class="pre">build/html</span></tt> subdirectory from the
     166SVN repository, commit that change, rebuild the web site, then add
     167the new <tt class="docutils literal"><span class="pre">build/html</span></tt> subdirectory back into SVN.</p>
     168</div>
     169</div>
    114170</div>
    115171</div>
     
    126182<li><a class="reference internal" href="#">Adding new examples</a><ul>
    127183<li><a class="reference internal" href="#setting-the-subversion-mime-type-of-a-file">setting the subversion mime type of a file</a></li>
     184<li><a class="reference internal" href="#publishing-new-content-as-html">Publishing new content as HTML</a><ul>
     185<li><a class="reference internal" href="#advisory-about-make-clean">Advisory about <tt class="docutils literal"><span class="pre">make</span> <span class="pre">clean</span></tt></a><ul>
     186<li><a class="reference internal" href="#restoring-svn-build-html-svn-subdirectory">Restoring SVN <tt class="docutils literal"><span class="pre">build/html/.svn</span></tt> subdirectory</a></li>
    128187</ul>
    129188</li>
    130189</ul>
     190</li>
     191</ul>
     192</li>
     193</ul>
    131194
    132195  <h4>Previous topic</h4>
    133   <p class="topless"><a href="programmable_pulse_train/index.html"
    134                         title="previous chapter">Programmable pulse train</a></p>
     196  <p class="topless"><a href="motor_accel_gate/index.html"
     197                        title="previous chapter">Motor accel/decel pulse gate</a></p>
    135198  <h4>Next topic</h4>
    136199  <p class="topless"><a href="coaching.html"
     
    168231             >next</a> |</li>
    169232        <li class="right" >
    170           <a href="programmable_pulse_train/index.html" title="Programmable pulse train"
     233          <a href="motor_accel_gate/index.html" title="Motor accel/decel pulse gate"
    171234             >previous</a> |</li>
    172235        <li><a href="index.html">softglueexamples 2012-06 documentation</a> &raquo;</li>
     
    175238    <div class="footer">
    176239        &copy; Copyright 2012, Kurt Goetze, BCDA.
    177       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
     240      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
    178241    </div>
    179242  </body>
  • softGlue_examples/build/html/coaching.html

    r879 r923  
    14914934
    15015035
    151 36</pre></div></td><td class="code"><div class="highlight"><pre><span class="cp">.. $Id: index.rst 878 2012-06-05 21:36:27Z jemian $</span>
     15136
     15237
     15338
     15439
     15540
     15641
     15742
     15843
     15944
     16045
     16146
     16247
     16348
     16449</pre></div></td><td class="code"><div class="highlight"><pre><span class="cp">.. $Id: index.rst 915 2012-06-12 21:53:35Z mooney $</span>
    152165
    153166<span class="gh">======================================================</span>
     
    165178
    166179
    167 Contents:
     180<span class="gh">Contents</span>
     181<span class="gh">==================</span>
    168182
    169183<span class="p">..</span> <span class="ow">toctree</span><span class="p">::</span>
     
    171185   
    172186   programmable_pulse_train/index
    173 
    174 Additional Help:
     187   gated_scaler/index
     188   pulse_burst/index
     189   delay_gen/index
     190   motor_accel_gate/index
     191
     192<span class="gh">URL for this documentation</span>
     193<span class="gh">++++++++++++++++++++++++++</span>
     194
     195This documentation is published directly from the XSD SVN server:
     196
     197<span class="m">*</span>  https://subversion.xray.aps.anl.gov/bcdaext/softGlue_examples/build/html/index.html
     198
     199<span class="gh">Additional Help</span>
     200<span class="gh">==================</span>
    175201
    176202<span class="p">..</span> <span class="ow">toctree</span><span class="p">::</span>
     
    180206   coaching
    181207
    182 <span class="gh">Indices and tables</span>
     208<span class="gh">Index and Search</span>
    183209<span class="gh">==================</span>
    184210
     
    347373151
    348374152
    349 153</pre></div></td><td class="code"><div class="highlight"><pre><span class="c1"># Makefile for Sphinx documentation</span>
     375153
     376154</pre></div></td><td class="code"><div class="highlight"><pre><span class="c1"># Makefile for Sphinx documentation</span>
    350377<span class="c1">#</span>
    351378
     
    388415
    389416<span class="n">clean:</span>
    390         <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>
     417        <span class="c1">#-rm -rf $(BUILDDIR)/*</span>
     418        <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><span class="n">doctrees</span>
    391419
    392420<span class="n">html:</span>
     
    565593    <div class="footer">
    566594        &copy; Copyright 2012, Kurt Goetze, BCDA.
    567       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
     595      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
    568596    </div>
    569597  </body>
  • softGlue_examples/build/html/genindex.html

    r878 r923  
    5151<div class="genindex-jumpbox">
    5252 <a href="#A"><strong>A</strong></a>
     53 | <a href="#B"><strong>B</strong></a>
     54 | <a href="#D"><strong>D</strong></a>
     55 | <a href="#G"><strong>G</strong></a>
    5356 | <a href="#H"><strong>H</strong></a>
     57 | <a href="#I"><strong>I</strong></a>
    5458 | <a href="#L"><strong>L</strong></a>
     59 | <a href="#M"><strong>M</strong></a>
    5560 | <a href="#P"><strong>P</strong></a>
    5661 | <a href="#R"><strong>R</strong></a>
     
    6873</tr></table>
    6974
     75<h2 id="B">B</h2>
     76<table style="width: 100%" class="indextable genindextable"><tr>
     77  <td style="width: 33%" valign="top"><dl>
     78     
     79  <dt>
     80    busy record
     81  </dt>
     82
     83      <dd><dl>
     84       
     85  <dt><a href="gated_scaler/index.html#index-2">in gated scaler</a>
     86  </dt>
     87
     88      </dl></dd>
     89  </dl></td>
     90</tr></table>
     91
     92<h2 id="D">D</h2>
     93<table style="width: 100%" class="indextable genindextable"><tr>
     94  <td style="width: 33%" valign="top"><dl>
     95     
     96  <dt><a href="delay_gen/index.html#index-0"><strong>delay generator</strong></a>
     97  </dt>
     98
     99  </dl></td>
     100</tr></table>
     101
     102<h2 id="G">G</h2>
     103<table style="width: 100%" class="indextable genindextable"><tr>
     104  <td style="width: 33%" valign="top"><dl>
     105     
     106  <dt><a href="gated_scaler/index.html#index-0"><strong>gated scaler</strong></a>
     107  </dt>
     108
     109  </dl></td>
     110</tr></table>
     111
    70112<h2 id="H">H</h2>
    71113<table style="width: 100%" class="indextable genindextable"><tr>
     
    84126</tr></table>
    85127
     128<h2 id="I">I</h2>
     129<table style="width: 100%" class="indextable genindextable"><tr>
     130  <td style="width: 33%" valign="top"><dl>
     131     
     132  <dt>
     133    interrupt
     134  </dt>
     135
     136      <dd><dl>
     137       
     138  <dt><a href="gated_scaler/index.html#index-1">in gated scaler</a>
     139  </dt>
     140
     141      </dl></dd>
     142  </dl></td>
     143</tr></table>
     144
    86145<h2 id="L">L</h2>
    87146<table style="width: 100%" class="indextable genindextable"><tr>
     
    94153</tr></table>
    95154
     155<h2 id="M">M</h2>
     156<table style="width: 100%" class="indextable genindextable"><tr>
     157  <td style="width: 33%" valign="top"><dl>
     158     
     159  <dt><a href="motor_accel_gate/index.html#index-0"><strong>motor_accel_gate</strong></a>
     160  </dt>
     161
     162  </dl></td>
     163</tr></table>
     164
    96165<h2 id="P">P</h2>
    97166<table style="width: 100%" class="indextable genindextable"><tr>
     
    102171
    103172  </dl></td>
     173  <td style="width: 33%" valign="top"><dl>
     174     
     175  <dt>
     176    Pulse-burst generator
     177  </dt>
     178
     179      <dd><dl>
     180       
     181  <dt><a href="pulse_burst/index.html#index-0"><strong>non-retriggerable</strong></a>
     182  </dt>
     183
     184      </dl></dd>
     185  </dl></td>
    104186</tr></table>
    105187
     
    121203  </dt>
    122204
     205     
     206  <dt>
     207    sseq record
     208  </dt>
     209
     210      <dd><dl>
     211       
     212  <dt><a href="gated_scaler/index.html#index-3">in gated scaler</a>
     213  </dt>
     214
     215      </dl></dd>
    123216  </dl></td>
    124217  <td style="width: 33%" valign="top"><dl>
     
    168261    <div class="footer">
    169262        &copy; Copyright 2012, Kurt Goetze, BCDA.
    170       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
     263      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
    171264    </div>
    172265  </body>
  • softGlue_examples/build/html/index.html

    r878 r923  
    5454<a class="reference external" href="http://www.aps.anl.gov/bcda/synApps/softGlue/softGlue.html">SoftGlue</a>
    5555FPGA project are shown.</p>
    56 <p>Contents:</p>
     56<div class="section" id="contents">
     57<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h2>
    5758<div class="toctree-wrapper compound">
    5859<ul>
    5960<li class="toctree-l1"><a class="reference internal" href="programmable_pulse_train/index.html">Programmable pulse train</a></li>
     61<li class="toctree-l1"><a class="reference internal" href="gated_scaler/index.html">Gated scaler</a></li>
     62<li class="toctree-l1"><a class="reference internal" href="pulse_burst/index.html">Pulse burst</a></li>
     63<li class="toctree-l1"><a class="reference internal" href="delay_gen/index.html">Delay generator</a></li>
     64<li class="toctree-l1"><a class="reference internal" href="motor_accel_gate/index.html">Motor accel/decel pulse gate</a></li>
    6065</ul>
    6166</div>
    62 <p>Additional Help:</p>
     67<div class="section" id="url-for-this-documentation">
     68<h3>URL for this documentation<a class="headerlink" href="#url-for-this-documentation" title="Permalink to this headline">¶</a></h3>
     69<p>This documentation is published directly from the XSD SVN server:</p>
     70<ul class="simple">
     71<li><a class="reference external" href="https://subversion.xray.aps.anl.gov/bcdaext/softGlue_examples/build/html/index.html">https://subversion.xray.aps.anl.gov/bcdaext/softGlue_examples/build/html/index.html</a></li>
     72</ul>
     73</div>
     74</div>
     75<div class="section" id="additional-help">
     76<h2>Additional Help<a class="headerlink" href="#additional-help" title="Permalink to this headline">¶</a></h2>
    6377<div class="toctree-wrapper compound">
    6478<ul>
     
    6781</ul>
    6882</div>
    69 <div class="section" id="indices-and-tables">
    70 <h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
     83</div>
     84<div class="section" id="index-and-search">
     85<h2>Index and Search<a class="headerlink" href="#index-and-search" title="Permalink to this headline">¶</a></h2>
    7186<ul class="simple">
    7287<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
     
    85100  <ul>
    86101<li><a class="reference internal" href="#">Documentation of Example Circuits for synApps SoftGlue</a><ul>
    87 <li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
     102<li><a class="reference internal" href="#contents">Contents</a><ul>
     103<li><a class="reference internal" href="#url-for-this-documentation">URL for this documentation</a></li>
     104</ul>
     105</li>
     106<li><a class="reference internal" href="#additional-help">Additional Help</a><ul>
     107</ul>
     108</li>
     109<li><a class="reference internal" href="#index-and-search">Index and Search</a></li>
    88110</ul>
    89111</li>
     
    129151    <div class="footer">
    130152        &copy; Copyright 2012, Kurt Goetze, BCDA.
    131       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
     153      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
    132154    </div>
    133155  </body>
  • softGlue_examples/build/html/programmable_pulse_train/index.html

    r878 r923  
    2727    <script type="text/javascript" src="../_static/doctools.js"></script>
    2828    <link rel="top" title="softglueexamples 2012-06 documentation" href="../index.html" />
    29     <link rel="next" title="Adding new examples" href="../adding_examples.html" />
     29    <link rel="next" title="Gated scaler" href="../gated_scaler/index.html" />
    3030    <link rel="prev" title="Documentation of Example Circuits for synApps SoftGlue" href="../index.html" />
    3131  </head>
     
    3838             accesskey="I">index</a></li>
    3939        <li class="right" >
    40           <a href="../adding_examples.html" title="Adding new examples"
     40          <a href="../gated_scaler/index.html" title="Gated scaler"
    4141             accesskey="N">next</a> |</li>
    4242        <li class="right" >
     
    9393                        title="previous chapter">Documentation of Example Circuits for synApps SoftGlue</a></p>
    9494  <h4>Next topic</h4>
    95   <p class="topless"><a href="../adding_examples.html"
    96                         title="next chapter">Adding new examples</a></p>
     95  <p class="topless"><a href="../gated_scaler/index.html"
     96                        title="next chapter">Gated scaler</a></p>
    9797  <h3>This Page</h3>
    9898  <ul class="this-page-menu">
     
    124124             >index</a></li>
    125125        <li class="right" >
    126           <a href="../adding_examples.html" title="Adding new examples"
     126          <a href="../gated_scaler/index.html" title="Gated scaler"
    127127             >next</a> |</li>
    128128        <li class="right" >
     
    134134    <div class="footer">
    135135        &copy; Copyright 2012, Kurt Goetze, BCDA.
    136       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
     136      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
    137137    </div>
    138138  </body>
  • softGlue_examples/build/html/search.html

    r873 r923  
    9494    <div class="footer">
    9595        &copy; Copyright 2012, Kurt Goetze, BCDA.
    96       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
     96      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
    9797    </div>
    9898  </body>
  • softGlue_examples/build/html/searchindex.js

    r879 r923  
    1 Search.setIndex({objects:{},terms:{programmable_pulse_train:[1,2],all:1,coach:[0,1],synapp:[0,1],just:1,show:[2,3],text:[1,2],devhelp:1,rst:[1,2],code:1,through:1,suno:1,file:[1,2],follow:2,i18nsphinxopt:1,find:1,help:[0,1],web:[1,2],softglueexampl:1,execut:1,easi:1,clk:3,chosen:1,restructuredtext:[0,1],makefil:1,apsshar:1,add:2,program:[1,3],"29z":[],under:2,local:1,sure:1,bin:1,linkcheck:1,them:1,sourc:[1,2],get:1,latex_paper_s:1,checkin:2,repo:1,sphinxbuild:1,cannot:1,gettext:1,backtick:1,now:1,like:1,name:1,level:1,edit:[1,2],dirhtml:1,adding_exampl:1,manual:1,html:[1,2],server:2,item:1,paper:1,necessari:2,integr:1,"_static":2,each:1,output:[1,3],complet:1,where:1,page:[0,1],view:1,pleas:1,softglu:[0,1],www:1,set:[1,2,3],mai:[1,2],linux:1,some:1,displai:2,see:2,pulse_train:1,"export":1,result:1,toctre:[1,2],home:1,allsphinxopt:1,out:1,even:1,index:[0,1,2],shown:[0,1],xor:[1,2],builddir:1,clock:3,section:1,definit:3,qcollectiongener:1,content:[0,1,2],larg:1,"new":[0,2],architecture_choic:1,gov:[1,2],ref:1,makeinfo:1,refer:2,assist:1,run:1,singl:1,parent:[1,2],jemian:1,javascript:2,here:1,paperopt_a4:1,extens:2,step:2,mime:2,repositori:[1,2],qthelp:1,path:1,"27z":1,sinc:1,paperopt_:1,paperopt_lett:1,search:[0,1],bcda:1,doctre:1,column:2,frequenc:3,surround:1,place:1,doctest:1,circuit:[0,1,3],pick:1,pdf:1,chang:1,qhcp:1,note:[1,2],bcdaext:[1,2],can:1,overview:1,pdflatex:1,automat:1,echo:1,down:3,deprec:1,unix:1,colon:1,blank:1,txt:1,your:1,differ:1,from:[1,2],wai:3,rebuild:[1,2],doubl:1,mkdir:1,sometim:1,messag:1,subvers:[1,2],avail:[1,2],anl:[1,2],json:1,underlin:1,pocoo:1,lot:1,resolut:3,addit:[0,1],type:[1,2],tell:[1,2],includ:1,genindex:1,properli:2,option:1,fpga:[0,1],latex:1,softglue_exampl:[1,2],imag:2,copi:2,about:1,ani:[1,2],train:[0,3],link:1,i18n:1,indent:1,line:1,inlin:1,phoni:1,info:1,pull:1,dff:3,look:1,possibl:1,access:1,intern:1,exampl:[0,1,2],project:[0,1],directori:[1,2],below:2,paragraph:1,whatev:1,abov:1,error:1,standalon:1,embed:1,more:1,sphinxopt:1,puls:[0,3],hhp:1,comput:1,want:1,process:1,share:1,site:2,indic:[0,1],liter:1,conf:1,tabl:[0,1],need:1,made:1,texinfo:1,check:1,counter:3,end:1,built:1,make:[1,2],when:2,off:3,same:2,write:1,python:1,other:1,build:[1,2,3],subdirectori:2,test:1,command:[1,2],you:1,document:[0,1,2],target:1,css:2,enabl:1,variabl:1,finish:1,http:[1,2],thi:[1,2,3],htmlhelp:1,symbol:1,previou:2,catalog:1,preset:3,letter:1,singlehtml:1,extern:1,org:1,man:1,svn:[1,2],workshop:1,sphinx:1,qhc:1,epub:1,latexpdf:1,builder:1,bottom:1,well:1,collectionfil:1,pickl:1,inset:1,part:1,environ:1,maxdepth:1,clean:1,time:[2,3],programm:[0,3],epd:1,left:2},objtypes:{},titles:["Documentation of Example Circuits for synApps SoftGlue","Additional Coaching on the use of reStructuredText","Adding new examples","Programmable pulse train"],objnames:{},filenames:["index","coaching","adding_examples","programmable_pulse_train/index"]})
     1Search.setIndex({objects:{},terms:{all:[0,2,3,4,6,7],coach:[1,4],edg:[0,3,7,6],four:[6,3],code:4,suno:4,follow:[0,7,2],i18nsphinxopt:4,whose:6,send:[0,7],apsshar:4,weizeorick:0,program:[4,5],"29z":[],under:2,sens:0,sent:[3,7],sourc:[4,2],everi:7,string:[0,3,7,6],checkin:2,rise:[0,3,7],fan:3,fall:[6,3],rebuild:[4,2],brows:2,circuitri:3,level:4,did:3,ref:4,cmd:[3,7],"try":2,item:4,race:7,pleas:4,zero:[6,3],download:[0,3,7,6],allsphinxopt:4,even:4,index:[1,4,2],what:2,xor:4,builddir:4,clock:[6,3,7,5],neg:7,section:4,"while":7,access:4,"new":[1,2],method:[],whatev:[0,3,4,7,6],gener:[0,1,6,3],clock_8mhz:3,here:[0,6,4,2],dncntr:[0,6,7],path:4,"27z":[],modifi:[7,2],sinc:4,valu:[0,3,7,6],wait:[0,3],search:[1,4],bcda:4,val_:7,doctest:4,pick:4,extrem:3,chang:[3,4,2],scaler:[1,3],appli:7,modul:3,backtick:4,deprec:4,unix:4,motor:[1,7],txt:4,select:2,from:[0,1,2,3,4,6,7],describ:3,would:[3,7],doubl:4,subvers:[1,4,2],few:2,call:0,taken:0,scope:6,calc:3,type:[4,2],tell:[4,2],more:[4,2],genindex:4,trail:7,train:[1,5],accept:7,phoni:4,must:[6,3],fly:7,restor:2,prepar:6,work:2,paragraph:4,can:[6,3,4,7,2],purpos:3,control:[0,3,7],hhp:4,gateout:7,scan:[6,7],process:[0,3,4,6],dff:[3,7,5],pulse_burst:[0,4],share:4,indic:3,high:6,dbloadrecord:7,liter:4,want:[3,4,7],schemat:0,occur:[0,3,7],delai:[0,1,6],cours:3,multipl:6,divid:6,anoth:7,get:[3,4],divis:7,subdirectori:2,instead:[3,2],css:2,updat:[3,2],velo:7,earlier:3,befor:[3,7],catalog:4,delay_gen:[6,4],mai:[4,2],sseq:3,data:7,man:4,"short":[3,7],counter:[6,3,7,5],produc:[0,3,7,6],caus:[3,7],callback:3,combin:7,pocoo:4,allow:7,mechan:7,"2n_a":7,help:[1,4],over:[],devhelp:4,becaus:[0,3],paper:4,through:[4,7],still:[3,2],paramet:0,write:[6,3,4,7],render:2,clk:5,chosen:4,passag:7,better:3,gatedcount:3,might:7,linkcheck:4,them:[3,4,2],"return":6,greater:6,thei:[6,2],python:4,overal:3,initi:[6,7],qhc:4,gate:[1,7,3],interrupt:[6,3],now:[4,2],nor:3,rescind:3,choic:7,flipflop:7,document:[0,1,2,3,4,6,7],name:[6,3,4,7],edit:[0,2,3,4,6,7],"2_preset":7,separ:6,easili:7,each:[0,6,4],ceas:3,confid:2,pdflatex:4,just:4,replac:[0,3,7,6],procedur:2,connect:[3,7],happen:2,extract:0,out:[3,4,7],variabl:4,shown:[1,4,7,3],goe:[6,3,7],publish:[1,4,2],content:[1,4,2],adapt:0,hardwar:3,gov:[1,4,2],occurr:[0,3,7,6],makeinfo:4,integr:4,after:[0,3,7,6],standard:[3,2],standalon:4,reason:3,base:3,mime:2,theori:[6,3],org:4,promptli:3,indent:4,wai:[6,3,7,2,5],doctre:[4,2],frequenc:5,could:[6,7],count:[6,3,7],motion:7,thing:2,length:[0,6],place:4,circuit:[0,1,3,4,5,6,7],retain:2,first:[0,7],oper:[6,3],accl:7,directli:[1,4,2],onc:2,number:[0,3,7,6],decel:[1,7],echo:4,softglue_conveni:3,done:[3,2],"long":[6,3],blank:4,differ:4,top:[6,7],mkdir:4,sometim:4,messag:4,underlin:4,too:6,john:0,"final":7,includ:[4,7,2],option:4,softglue_exampl:[1,4,2],copi:2,specifi:[0,3,7,6],part:[0,4,7],rst:[4,2],off:[3,5],than:6,std:3,conveni:6,target:4,remov:2,second:[0,3],project:[1,4],posit:[6,7],arrang:[6,7],builder:4,sai:7,comput:4,anl:[1,4],ani:[0,3,4,2],rai:0,have:[6,3,7],tabl:[],need:[3,4,7,2],divbyn:[6,3],built:[4,2],inform:2,rout:6,retrigger:0,note:[3,4,7,2],also:[6,3,2],exampl:[0,1,4,7,2],build:[1,2,3,4,5,6],which:[0,3,6],environ:4,detector:7,singl:4,begin:[6,3],sure:4,htmlhelp:4,though:3,previou:2,reach:6,preset:[0,6,5],letter:4,programm:[0,1,5],epd:4,epub:4,latex:4,give:3,url:[1,4],motor_accel_g:[4,7],clear:[0,3,6],flop:[6,3],drive:3,doe:0,deni:7,declar:3,snapshot:[0,3,7,6],clean:[4,2],mre:7,programmable_pulse_train:[4,2],busy1:3,synapp:[1,4,3],show:[6,3,7,2,5],text:[4,2],advisori:2,find:4,onli:[3,7,2],acquir:[0,3,7],configur:[0,3,7],written:6,should:2,busi:3,local:4,info:4,move:[3,7],unus:2,motor_accel_gate_transform:7,latex_paper_s:4,sscan:3,stop:3,accel:[1,7],repo:4,cannot:[4,7],requir:3,enabl:[6,3,4],xxxapp:7,common:7,qcollectiongener:4,where:[3,4,7],view:4,set:[0,2,3,4,5,6,7],burst:[0,1],abort:3,displai:2,see:[7,2],sec:0,result:[3,4],respons:0,striptool:6,xrai:[1,4],correctli:3,databas:[3,7],someth:7,figur:3,between:[0,7],"import":2,architecture_choic:4,screen:7,parent:[4,2],jemian:2,javascript:2,paperopt_a4:4,extens:2,lazi:6,spare:6,come:3,embed:4,addit:[0,1,4,3],paperopt_lett:4,last:6,howev:6,equal:6,context:7,pdf:[0,4],load:[0,3,7,6],acceler:7,timebas:3,point:7,overview:4,period:[0,3,6],motorrecord:7,colon:4,linux:4,respect:[6,7],assum:7,gated_scal:4,invert:7,three:0,been:[3,7,2],accumul:3,json:4,workshop:4,immedi:3,burtwb:[0,3,7,6],both:7,imag:[0,2],xxx:[0,3,7,6],vba:7,togeth:7,i18n:4,readrat:3,those:3,"case":3,look:[4,2],durat:0,calcul:7,abov:[0,3,4,7],error:4,avavail:[],sphinxopt:4,bin:[4,2],readi:7,deliv:[3,7,2],site:2,itself:3,conf:4,texinfo:4,n_a:7,n_c:7,documentatiojn:2,receiv:3,make:[6,3,4,7,2],stepper:7,same:[3,7,2],handl:7,html:[1,4,2],eventu:3,upcntr:[0,3,7],"35z":4,latexpdf:4,complet:[3,4,2],shakerclk:0,finish:[3,4],http:[1,4],assist:4,user:3,extern:[6,4,7],ioc:[0,3,7,6],implement:[6,3,7],collectionfil:4,mention:3,thu:7,well:4,non:0,pickl:4,client:[3,2],command:[0,2,3,4,6,7],thi:[0,1,2,3,4,5,6,7],deceler:7,everyth:0,left:2,tim:[0,3,7,6],identifi:2,execut:[3,4],simpli:3,simultan:7,speed:7,web:[4,2],softglueexampl:4,paperopt_:4,easi:[4,2],softglu:[0,1,3,4,6,7],trigger:[6,7],restructuredtext:[1,4],makefil:[4,2],add:[7,2],snap:[0,3,7,6],input:[0,3,7,6],real:6,applic:0,read:3,sphinxbuild:4,know:[3,7],bit:3,republish:2,like:[4,7,2],gatedscal:3,dirhtml:4,signal:[6,3,7],manual:[4,7],elaps:3,server:[1,4,2],necessari:2,either:[6,3,2],"_static":2,output:[0,3,4,5,6,7],adding_exampl:4,www:[4,2],moonei:[0,3,4,7,6],old:2,who:2,captur:[6,7],suppli:2,some:[4,7],back:2,mhz:3,intern:4,pulse_train:4,"export":4,toctre:[4,2],home:4,total:7,plenti:7,lead:7,channel:[6,3],avoid:[7,2],definit:5,larg:4,condit:7,epic:[6,3,7],refer:2,plu:7,object:0,run:4,xsd:[1,4],usag:[0,3,7,6],burt:[0,3,7,6],step:[7,2],repositori:[4,2],qthelp:4,shaken:0,about:[4,2],actual:3,column:2,surround:4,page:[1,4,2],microsecond:3,act:2,singlehtml:4,disabl:[6,3],qhcp:4,automat:4,down:[6,7,5],next:[0,6,7],your:[0,3,4,7,6],accordingli:2,val:7,support:7,transform:7,fast:3,avail:[6,3,4],start:[0,3,7,6],reli:3,gatedstart:3,low:6,lot:4,resolut:5,"function":3,"1_preset":7,properli:2,fpga:[1,4],enough:6,forc:2,link:4,sphinx:[4,2],line:4,inlin:4,buf:[6,3,7],reset:[6,7],pull:4,made:[6,4],possibl:[4,2],commit:2,flip:[6,3],until:[3,7],record:[6,3,7],below:2,problem:[7,2],unformat:2,puls:[0,1,3,5,6,7],constant:7,pin:7,certain:2,dure:[0,7],doesn:3,stoptim:3,diagnost:[0,7],file:[0,2,3,4,6,7],trace:6,check:4,when:[0,3,7,2,6],inset:4,gettext:4,end:[4,7],field:[6,3,7],other:[4,7],test:[4,7],you:[0,2,3,4,6,7],sseq1:3,repeat:0,sequenc:[6,3],symbol:4,bcdaext:[1,4],ca_put_callback:3,stai:3,svn:[1,4,2],"_count":3,"125nsec":0,directori:[4,2],bottom:4,descript:7,portion:7,ignor:[0,7],maxdepth:4,time:[0,2,3,5,6,7]},objtypes:{},titles:["Pulse burst","Documentation of Example Circuits for synApps SoftGlue","Adding new examples","Gated scaler","Additional Coaching on the use of reStructuredText","Programmable pulse train","Delay generator","Motor accel/decel pulse gate"],objnames:{},filenames:["pulse_burst/index","index","adding_examples","gated_scaler/index","coaching","programmable_pulse_train/index","delay_gen/index","motor_accel_gate/index"]})
  • softGlue_examples/make.bat

    r863 r923  
    4040
    4141if "%1" == "clean" (
    42         for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
    43         del /q /s %BUILDDIR%\*
     42        REM for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
     43        REM del /q /s %BUILDDIR%\*
     44        rmdir /q /s %BUILDDIR%\doctrees
     45        del /q /s %BUILDDIR%\doctrees
    4446        goto end
    4547)
  • softGlue_examples/source/adding_examples.rst

    r878 r923  
    2727++++++++++++++++++++++++++++++++++++++++++
    2828
    29 =========  ===============================================
     29=========  ========================================
    3030extension  command
    31 =========  ===============================================
     31=========  ========================================
    3232``.html``  ``svn ps svn:mime-type text/html``
    3333``.css``   ``svn ps svn:mime-type text/css``
    3434``.js``    ``svn ps svn:mime-type text/javascript``
    35 =========  ===============================================
     35=========  ========================================
    3636
    37 Any of these commands may be useful at times when adding
     37Publishing new content as HTML
     38++++++++++++++++++++++++++++++
     39
     40The subversion repository also can act as a WWW server.
     41It is possible to publish the built HTML documentatiojn
     42as a complete web site directly from the subversion server.
     43For this to happen, the built documentation needs to be added
     44to the subversion repository.  The MIME types of certain files
     45needs to be set properly so the SVN server can deliver them
     46identified in a way that WWW clients will render them properly.
     47
     48The commands below may be useful at times when adding
    3849new examples so the HTML files display properly from the
    3950subversion repository server::
    4051
    4152        cd {softGlue_examples}
     53       
     54        # these commands will add all built HTML content
     55        svn add build/html/*
     56        svn add build/html/*/*
     57        # -or-  (to be more selective as to what is published)
    4258        svn st -u
    43         svn add {any content from previous command with "?" in left column}
     59        svn add {any content from previous "svn st" command with "?" in left column}
     60       
     61        # Now, you need to set the MIME types properly
     62        # or the SVN server will display the pages unformatted.
    4463        svn ps svn:mime-type text/html build/html/*.html
    4564        svn ps svn:mime-type text/html build/html/*/*.html
     
    4766        svn ps svn:mime-type text/css build/html/_static/*.css
    4867
     68Advisory about ``make clean``
     69^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    4970
    50 .. note:: Web documentation available from the SVN server:
     71When a Sphinx web site is to be published from the SVN server,
     72it is important to avoid the use of ``make clean``.  The *clean*
     73procedure in the standard as-supplied Sphinx Makefile completely
     74removes all content under the ``build/``
     75subdirectory (including the ``build/html/.svn`` subdirectory)
     76and removes the subversion information necessary to republish the WWW site.
    5177
    52    https://subversion.xor.aps.anl.gov/bcdaext/softGlue_examples/build/html/index.html
     78Instead of ``make clean``, you can force a complete Sphinx rebuild
     79by removing the ``build/doctrees`` subdirectory.  Either edit
     80the Makefile accordingly (as has been done here) or use this command::
     81
     82   /bin/rm -rf build/doctrees
     83
     84On this modified Makefile, ``make clean`` should look like this::
     85
     86  [jemian@gov,286,softGlue_examples]$ make clean
     87  #-rm -rf build/*
     88  rm -rf build/doctrees
     89
     90
     91Restoring SVN ``build/html/.svn`` subdirectory
     92~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     93
     94If the ``build/html/.svn`` has been removed,
     95it can be easy to restore from the SVN repository.
     96Try these commands::
     97
     98   mv build build.modified
     99   svn update
     100   make html
     101
     102Once you are confident that things work the way they should,
     103you can remove the old ``build.modified`` directory::
     104
     105   /bin/rm -rf build.modified
     106
     107.. note:: This can still retain unused content in the ``build/html``
     108   subdirectory (only a problem for the few who browse the
     109   ``build/html`` subdirectory contents). 
     110   To completely rebuild the published web site), it
     111   may be necessary to remove the ``build/html`` subdirectory from the
     112   SVN repository, commit that change, rebuild the web site, then add
     113   the new ``build/html`` subdirectory back into SVN.
  • softGlue_examples/source/index.rst

    r915 r923  
    1515
    1616
    17 Contents:
     17Contents
     18==================
    1819
    1920.. toctree::
     
    2627   motor_accel_gate/index
    2728
    28 Additional Help:
     29URL for this documentation
     30++++++++++++++++++++++++++
     31
     32This documentation is published directly from the XSD SVN server:
     33
     34*  https://subversion.xray.aps.anl.gov/bcdaext/softGlue_examples/build/html/index.html
     35
     36Additional Help
     37==================
    2938
    3039.. toctree::
     
    3443   coaching
    3544
    36 Indices and tables
     45Index and Search
    3746==================
    3847
Note: See TracChangeset for help on using the changeset viewer.