Changeset 866


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

a little more help

Location:
pulse_train_doc
Files:
4 edited

Legend:

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

    r865 r866  
    1 .. $Id: coaching1.rst 863 2012-06-05 07:20:49Z jemian $
     1.. $Id: coaching1.rst 865 2012-06-05 07:29:12Z jemian $
    22
    33===========================================
     
    2121        make html
    2222
     23You can get PDF documentation, as well.
     24To do that, type::
     25
     26        make latexpdf
     27
     28and then pick that up in ``build/latex/pulse_train.pdf``.  [#]_
     29
    2330.. [#] Sphinx uses Python.  You may want to build this on an APS
    2431   SunOS or linux computer.  If so, you'll need to make sure
    2532   that the ``/APSshare/epd/{architecture_choice}/bin`` directory
    2633   is on your executable path.
     34
     35.. [#] You can change a lot of options in the ``source/../conf.py`` file.
    2736
    2837SVN export this example documentation
  • pulse_train_doc/build/html/coaching1.html

    r865 r866  
    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. <a class="footnote-reference" href="#id2" id="id1">[1]</a>
     57<p>This is a just an example of writing the documentation using sphinx. <a class="footnote-reference" href="#id3" id="id1">[1]</a>
    5858It 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
     
    6666make html</pre>
    6767</div>
    68 <table class="docutils footnote" frame="void" id="id2" rules="none">
     68<p>You can get PDF documentation, as well.
     69To do that, type:</p>
     70<div class="highlight-python"><pre>make latexpdf</pre>
     71</div>
     72<p>and then pick that up in <tt class="docutils literal"><span class="pre">build/latex/pulse_train.pdf</span></tt>.  <a class="footnote-reference" href="#id4" id="id2">[2]</a></p>
     73<table class="docutils footnote" frame="void" id="id3" rules="none">
    6974<colgroup><col class="label" /><col /></colgroup>
    7075<tbody valign="top">
     
    7378that the <tt class="docutils literal"><span class="pre">/APSshare/epd/{architecture_choice}/bin</span></tt> directory
    7479is on your executable path.</td></tr>
     80</tbody>
     81</table>
     82<table class="docutils footnote" frame="void" id="id4" rules="none">
     83<colgroup><col class="label" /><col /></colgroup>
     84<tbody valign="top">
     85<tr><td class="label"><a class="fn-backref" href="#id2">[2]</a></td><td>You can change a lot of options in the <tt class="docutils literal"><span class="pre">source/../conf.py</span></tt> file.</td></tr>
    7586</tbody>
    7687</table>
  • pulse_train_doc/build/html/searchindex.js

    r865 r866  
    1 Search.setIndex({objects:{},terms:{all:1,coach:[0,1],help:1,just:1,text:1,devhelp:1,i18n:1,code:[0,1],through:1,suno:1,extern:[0,1],i18nsphinxopt:1,find:1,web:1,paperopt_:1,easi:1,fancier:1,restructuredtext:[0,1],makefil:[0,1],apsshar:1,add:1,program:1,local:1,bin:1,linkcheck:1,them:1,liter:[0,1],get:1,latex_paper_s:1,finish:1,repo:1,sphinxbuild:1,cannot:1,backtick:1,"49z":1,veri:1,bit:1,now:1,name:1,bar:1,like:1,level:1,edit:1,dirhtml:1,manual:1,item:1,paper:1,integr:1,each:1,qcollectiongener:1,complet:1,where:1,page:[0,1],view:1,pleas:1,pdflatex:1,set:1,blank:1,some:1,intern:1,pulse_train:1,"export":[0,1],result:1,toctre:1,home:1,allsphinxopt:1,even:1,index:[0,1],xor:1,builddir:1,bottom:1,section:1,medm:[0,1],content:[0,1],figur:[0,1],larg:1,architecture_choic:1,gov:1,ref:1,screen:[0,1],makeinfo:1,can:1,run:1,pulse_train_doc:1,jemian:1,differ:1,here:1,paperopt_lett:1,standalon:1,repositori:1,output:[0,1],qthelp:1,path:1,sinc:1,paperopt_a4:1,about:1,indent:1,doctre:1,symbol:1,surround:1,caption:[0,1],perhap:1,place:1,doctest:1,latexpdf:1,singlehtml:1,chang:1,top:1,qhcp:1,bcdaext:1,overview:1,automat:1,sometim:1,deprec:1,unix:[0,1],colon:1,linux:1,txt:1,your:1,square_wav:1,adl_screen:1,from:1,execut:1,support:1,doubl:1,mkdir:1,three:[0,1],messag:1,subvers:1,avail:1,anl:1,json:1,underlin:1,pocoo:1,dff:[0,1],type:1,tell:1,includ:1,genindex:1,desir:1,glob:1,latex:1,imag:1,search:[0,1],rebuild:1,train:[0,1],link:1,rst:1,actual:[0,1],line:1,inlin:[0,1],phoni:1,png:1,info:1,pull:1,made:1,target:1,possibl:1,plain:1,access:1,exampl:[0,1],project:1,paragraph:1,whatev:1,abov:1,error:1,embed:1,more:1,sphinxopt:1,puls:[0,1],sai:[0,1],hhp:1,comput:1,file:1,look:1,process:1,share:1,ani:1,indic:[0,1],sourc:1,other:[0,1],want:1,tabl:[0,1],need:1,texinfo:1,check:1,echo:1,write:1,end:1,built:1,titl:1,make:1,gettext:1,note:1,python:1,html:1,build:1,test:1,command:1,you:1,document:[0,1],singl:1,enabl:1,variabl:1,sure:1,http:1,clean:1,htmlhelp:1,org:1,assist:1,sphinxdoc:1,catalog:1,letter:1,pdf:1,mai:1,epub:1,man:1,svn:[0,1],workshop:1,sphinx:1,qhc:1,directori:1,doc:[],builder:1,collectionfil:1,pickl:1,inset:1,part:1,environ:1,maxdepth:1,thi:[0,1],programm:[0,1],epd:1},objtypes:{},titles:["Documentation of Programmable pulse train","Coaching on the use of reStructuredText"],objnames:{},filenames:["index","coaching1"]})
     1Search.setIndex({objects:{},terms:{all:1,coach:[0,1],help:1,just:1,text:1,devhelp:1,i18n:1,code:[0,1],through:1,suno:1,file:1,extern:[0,1],i18nsphinxopt:1,find:1,web:1,paperopt_:1,easi:1,singl:1,fancier:1,restructuredtext:[0,1],makefil:[0,1],apsshar:1,add:1,program:1,local:1,bin:1,linkcheck:1,them:1,liter:[0,1],get:1,latex_paper_s:1,finish:1,repo:1,sphinxbuild:1,cannot:1,backtick:1,"49z":1,veri:1,bit:1,now:1,name:1,bar:1,like:1,level:1,edit:1,dirhtml:1,manual:1,item:1,paper:1,integr:1,each:1,qcollectiongener:1,complet:1,where:1,page:[0,1],view:1,pleas:1,pdflatex:1,set:1,blank:1,some:1,intern:1,pulse_train:1,"export":[0,1],result:1,toctre:1,home:1,allsphinxopt:1,even:1,index:[0,1],xor:1,builddir:1,bottom:1,section:1,medm:[0,1],content:[0,1],figur:[0,1],larg:1,architecture_choic:1,gov:1,ref:1,jemian:1,makeinfo:1,can:1,run:1,pulse_train_doc:1,screen:[0,1],differ:1,here:1,paperopt_lett:1,standalon:1,repositori:1,output:[0,1],qthelp:1,path:1,sinc:1,paperopt_a4:1,about:1,indent:1,doctre:1,symbol:1,surround:1,caption:[0,1],perhap:1,place:1,doctest:1,pick:1,singlehtml:1,chang:1,top:1,qhcp:1,bcdaext:1,overview:1,automat:1,sometim:1,deprec:1,unix:[0,1],colon:1,linux:1,txt:1,your:1,square_wav:1,adl_screen:1,from:1,execut:1,support:1,doubl:1,mkdir:1,three:[0,1],messag:1,subvers:1,avail:1,anl:1,json:1,underlin:1,pocoo:1,lot:1,dff:[0,1],type:1,tell:1,includ:1,genindex:1,desir:1,option:1,latex:1,imag:1,search:[0,1],rebuild:1,part:1,link:1,epub:1,rst:1,actual:[0,1],line:1,inlin:[0,1],phoni:1,png:1,info:1,pull:1,made:1,target:1,possibl:1,plain:1,access:1,exampl:[0,1],project:1,paragraph:1,whatev:1,abov:1,error:1,embed:1,more:1,sphinxopt:1,puls:[0,1],sai:[0,1],hhp:1,comput:1,want:1,look:1,process:1,share:1,ani:1,indic:[0,1],sourc:1,other:[0,1],conf:1,tabl:[0,1],need:1,texinfo:1,check:1,echo:1,write:1,end:1,built:1,titl:1,make:1,gettext:1,note:1,python:1,html:1,build:1,test:1,command:1,you:1,document:[0,1],latexpdf:1,enabl:1,variabl:1,sure:1,http:1,clean:1,htmlhelp:1,glob:1,assist:1,sphinxdoc:1,catalog:1,letter:1,pdf:1,mai:1,org:1,man:1,svn:[0,1],workshop:1,sphinx:1,qhc:1,directori:1,doc:[],builder:1,well:1,collectionfil:1,pickl:1,inset:1,train:[0,1],environ:1,maxdepth:1,thi:[0,1],programm:[0,1],epd:1},objtypes:{},titles:["Documentation of Programmable pulse train","Coaching on the use of reStructuredText"],objnames:{},filenames:["index","coaching1"]})
  • pulse_train_doc/source/coaching1.rst

    r865 r866  
    2121        make html
    2222
     23You can get PDF documentation, as well.
     24To do that, type::
     25
     26        make latexpdf
     27
     28and then pick that up in ``build/latex/pulse_train.pdf``.  [#]_
     29
    2330.. [#] Sphinx uses Python.  You may want to build this on an APS
    2431   SunOS or linux computer.  If so, you'll need to make sure
    2532   that the ``/APSshare/epd/{architecture_choice}/bin`` directory
    2633   is on your executable path.
     34
     35.. [#] You can change a lot of options in the ``source/../conf.py`` file.
    2736
    2837SVN export this example documentation
Note: See TracChangeset for help on using the changeset viewer.