Changeset 878


Ignore:
Timestamp:
Jun 5, 2012 4:36:27 PM (10 years ago)
Author:
jemian
Message:

add some help

Location:
softGlue_examples
Files:
5 added
7 edited
1 moved

Legend:

Unmodified
Added
Removed
  • softGlue_examples/build/html/_sources/index.txt

    r877 r878  
    2222   programmable_pulse_train/index
    2323
     24Additional Help:
     25
     26.. toctree::
     27   :maxdepth: 1
     28     
     29   adding_examples
     30   coaching
     31
    2432Indices and tables
    2533==================
  • softGlue_examples/build/html/genindex.html

    r873 r878  
    5050
    5151<div class="genindex-jumpbox">
    52  <a href="#P"><strong>P</strong></a>
     52 <a href="#A"><strong>A</strong></a>
     53 | <a href="#H"><strong>H</strong></a>
     54 | <a href="#L"><strong>L</strong></a>
     55 | <a href="#P"><strong>P</strong></a>
     56 | <a href="#R"><strong>R</strong></a>
    5357 | <a href="#S"><strong>S</strong></a>
    5458 
    5559</div>
     60<h2 id="A">A</h2>
     61<table style="width: 100%" class="indextable genindextable"><tr>
     62  <td style="width: 33%" valign="top"><dl>
     63     
     64  <dt><a href="adding_examples.html#index-0"><strong>add new examples</strong></a>
     65  </dt>
     66
     67  </dl></td>
     68</tr></table>
     69
     70<h2 id="H">H</h2>
     71<table style="width: 100%" class="indextable genindextable"><tr>
     72  <td style="width: 33%" valign="top"><dl>
     73     
     74  <dt><a href="coaching.html#index-3"><strong>help</strong></a>
     75  </dt>
     76
     77  </dl></td>
     78  <td style="width: 33%" valign="top"><dl>
     79     
     80  <dt><a href="coaching.html#index-0">html</a>
     81  </dt>
     82
     83  </dl></td>
     84</tr></table>
     85
     86<h2 id="L">L</h2>
     87<table style="width: 100%" class="indextable genindextable"><tr>
     88  <td style="width: 33%" valign="top"><dl>
     89     
     90  <dt><a href="coaching.html#index-2">level</a>
     91  </dt>
     92
     93  </dl></td>
     94</tr></table>
     95
    5696<h2 id="P">P</h2>
    5797<table style="width: 100%" class="indextable genindextable"><tr>
     
    5999     
    60100  <dt><a href="programmable_pulse_train/index.html#index-0"><strong>programmable pulse train</strong></a>
     101  </dt>
     102
     103  </dl></td>
     104</tr></table>
     105
     106<h2 id="R">R</h2>
     107<table style="width: 100%" class="indextable genindextable"><tr>
     108  <td style="width: 33%" valign="top"><dl>
     109     
     110  <dt><a href="coaching.html#index-1">rebuild</a>
    61111  </dt>
    62112
  • softGlue_examples/build/html/index.html

    r876 r878  
    5858<ul>
    5959<li class="toctree-l1"><a class="reference internal" href="programmable_pulse_train/index.html">Programmable pulse train</a></li>
     60</ul>
     61</div>
     62<p>Additional Help:</p>
     63<div class="toctree-wrapper compound">
     64<ul>
     65<li class="toctree-l1"><a class="reference internal" href="adding_examples.html">Adding new examples</a></li>
     66<li class="toctree-l1"><a class="reference internal" href="coaching.html">Additional Coaching on the use of reStructuredText</a></li>
    6067</ul>
    6168</div>
  • softGlue_examples/build/html/programmable_pulse_train/index.html

    r876 r878  
    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" />
    2930    <link rel="prev" title="Documentation of Example Circuits for synApps SoftGlue" href="../index.html" />
    3031  </head>
     
    3637          <a href="../genindex.html" title="General Index"
    3738             accesskey="I">index</a></li>
     39        <li class="right" >
     40          <a href="../adding_examples.html" title="Adding new examples"
     41             accesskey="N">next</a> |</li>
    3842        <li class="right" >
    3943          <a href="../index.html" title="Documentation of Example Circuits for synApps SoftGlue"
     
    8892  <p class="topless"><a href="../index.html"
    8993                        title="previous chapter">Documentation of Example Circuits for synApps SoftGlue</a></p>
     94  <h4>Next topic</h4>
     95  <p class="topless"><a href="../adding_examples.html"
     96                        title="next chapter">Adding new examples</a></p>
    9097  <h3>This Page</h3>
    9198  <ul class="this-page-menu">
     
    117124             >index</a></li>
    118125        <li class="right" >
     126          <a href="../adding_examples.html" title="Adding new examples"
     127             >next</a> |</li>
     128        <li class="right" >
    119129          <a href="../index.html" title="Documentation of Example Circuits for synApps SoftGlue"
    120130             >previous</a> |</li>
  • softGlue_examples/build/html/searchindex.js

    r877 r878  
    1 Search.setIndex({objects:{},terms:{set:1,synapp:0,show:1,indic:0,down:1,tabl:0,clock:1,index:0,shown:0,wai:1,clk:1,definit:1,content:0,softglu:0,program:1,build:1,dff:1,thi:1,fpga:0,resolut:1,train:[0,1],programm:[0,1],search:0,document:0,off:1,frequenc:1,counter:1,exampl:0,project:0,preset:1,circuit:[0,1],time:1,output:1,page:0,puls:[0,1]},objtypes:{},titles:["Documentation of Example Circuits for synApps SoftGlue","Programmable pulse train"],objnames:{},filenames:["index","programmable_pulse_train/index"]})
     1Search.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,python:1,i18n:1,code:1,through:1,suno:1,extern:1,follow:2,i18nsphinxopt:1,find:1,help:[0,1],web:[1,2],softglueexampl:1,execut:1,easi:1,clk:3,chosen:1,copi:2,restructuredtext:[0,1],makefil:1,apsshar:1,add:2,program:[1,3],"29z":1,under:2,local:1,bin:1,linkcheck:1,them:1,sourc:[1,2],whatev:1,get:1,latex_paper_s:1,checkin:2,finish:1,repo:1,sphinxbuild:1,cannot:1,gettext:1,automat:1,part:1,now:1,like:1,name:1,level:1,edit:[1,2],dirhtml:1,adding_exampl:1,manual:1,server:2,item:1,paper:1,necessari:2,integr:1,"_static":2,each:1,output:[1,3],where:1,page:[0,1],view:1,pleas:1,www:1,set:[1,2,3],blank:1,some:1,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],larg:1,"new":[0,2],architecture_choic:1,gov:[1,2],ref:1,sphinx:1,makeinfo:1,refer:2,run:1,parent:[1,2],jemian:1,javascript:2,here:1,paperopt_a4:1,extens:2,step:2,mime:2,repositori:[1,2],css:2,qthelp:1,path:1,sinc:1,paperopt_:1,paperopt_lett:1,search:[0,1],bcda:1,doctre:1,frequenc:3,surround:1,place:1,doctest:1,circuit:[0,1,3],pick:1,pdf:1,chang:1,other:1,qhcp:1,letter:1,overview:1,pdflatex:1,backtick:1,echo:1,down:3,deprec:1,unix:1,enabl:1,colon:1,linux: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],process:1,json:1,underlin:1,pocoo:1,lot:1,addit:[0,1],type:[1,2],tell:[1,2],includ:1,genindex:1,properli:2,option:1,fpga:[0,1],softglue_exampl:[1,2],imag:2,resolut:3,about:1,site:2,train:[0,3],link:1,intern:1,epub:1,rst:[1,2],indent:1,line:1,inlin:1,phoni:1,info:1,pull:1,dff:3,look:1,possibl:1,conf:1,access:1,displai:2,project:[0,1],below:2,paragraph:1,can:1,abov:1,error:1,standalon:1,embed:1,more:1,sphinxopt:1,puls:[0,3],hhp:1,comput:1,want:1,anl:[1,2],share:1,ani:[1,2],indic:[0,1],liter:1,file:[1,2],tabl:[0,1],need:1,made:1,texinfo:1,check:1,write:1,end:1,built:1,make:[1,2],when:2,same:2,workshop:1,note:[1,2],softglu:[0,1],html:[1,2],build:[1,2,3],subdirectori:2,test:1,environ:1,you:1,document:[0,1,2],target:1,singl:1,complet:1,variabl:1,sure:1,http:[1,2],clean:1,htmlhelp:1,symbol:1,assist:1,bottom:1,catalog:1,preset:3,bcdaext:[1,2],singlehtml:1,mai:[1,2],org:1,man:1,svn:[1,2],latex:1,off:3,qhc:1,directori:[1,2],latexpdf:1,builder:1,counter:3,well:1,collectionfil:1,pickl:1,inset:1,exampl:[0,1,2],command:[1,2],maxdepth:1,thi:[1,2,3],time:[2,3],programm:[0,3],epd:1},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"]})
  • softGlue_examples/source/coaching.rst

    r876 r878  
    11.. $Id$
    22
    3 ===========================================
    4 Adding new examples
    5 ===========================================
    6 
    7 To add new examples, follow these steps:
    8 
    9 #. make a new subdirectory under ``source/``
    10 #. copy any image files into this new subdirectory
    11 #. copy ``programmable_pulse_train/index.rst`` into this new subdirectory
    12 #. edit the new ``index.rst`` file to show the images and text for this new example
    13 #. edit ``source/index.rst`` and add a reference to the new directory in the ``toctree`` under ``programmable_pulse_train/index``
    14 #. in ``source``, add the new directory to subversion
    15 #. in ``source/..`` (parent directory), type ``make html`` to rebuild the web site
    16 #. it may be necessary to tell subversion the mime type of the html file(s), see below
    17 #. in the same directory, do a subversion checkin:  ``svn ci -m "new example"``
    18 
    19 setting the subversion mime type of a file
    20 ++++++++++++++++++++++++++++++++++++++++++
    21 
    22 =========  ===============================================
    23 extension  command
    24 =========  ===============================================
    25 ``.html``  ``svn ps svn:mime-type text/html``
    26 ``.css``   ``svn ps svn:mime-type text/css``
    27 ``.js``    ``svn ps svn:mime-type text/javascript``
    28 =========  ===============================================
    29 
    30 Any of these commands may be useful at times when adding
    31 new examples so the HTML files display properly from the
    32 subversion repository server::
    33 
    34         cd {softGlue_examples}
    35         svn ps svn:mime-type text/html build/html/*.html
    36         svn ps svn:mime-type text/html build/html/*/*.html
    37         svn ps svn:mime-type text/javascript build/html/_static/*.js
    38         svn ps svn:mime-type text/css build/html/_static/*.css
    39 
    40 
    41 
    42 .. note:: Web documentation available from the SVN server at:
    43    https://subversion.xor.aps.anl.gov/bcdaext/softGlue_examples/build/html/index.html
    44 
    45 
     3======================================================
    464Additional Coaching on the use of reStructuredText
    47 ---------------------------------------------------
     5======================================================
    486
    497This is a just an example of writing the documentation using sphinx. [#]_
     
    13189    :linenos:
    13290    :language: guess
    133 
    134 Indices and tables
    135 ==================
    136 
    137 * :ref:`genindex`
    138 * :ref:`search`
    139 
  • softGlue_examples/source/index.rst

    r876 r878  
    2222   programmable_pulse_train/index
    2323
     24Additional Help:
     25
     26.. toctree::
     27   :maxdepth: 1
     28     
     29   adding_examples
     30   coaching
     31
    2432Indices and tables
    2533==================
Note: See TracChangeset for help on using the changeset viewer.