Changeset 876


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

ready

Location:
softGlue_examples
Files:
9 edited

Legend:

Unmodified
Added
Removed
  • softGlue_examples/README

    r872 r876  
    1 $Id $
     1$Id$
    22
    33This directory contains a documentation project for softGlue examples.
  • softGlue_examples/build/html/_sources/index.txt

    r873 r876  
    22
    33======================================================
    4 Documentation of Example Circuits for synApps:SoftGlue
     4Documentation of Example Circuits for synApps SoftGlue
    55======================================================
    66
  • softGlue_examples/build/html/index.html

    r873 r876  
    99    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    1010   
    11     <title>Documentation of Example Circuits for synApps:SoftGlue &mdash; softglueexamples 2012-06 documentation</title>
     11    <title>Documentation of Example Circuits for synApps SoftGlue &mdash; softglueexamples 2012-06 documentation</title>
    1212   
    1313    <link rel="stylesheet" href="_static/default.css" type="text/css" />
     
    4949           
    5050  <div class="section" id="documentation-of-example-circuits-for-synapps-softglue">
    51 <h1>Documentation of Example Circuits for synApps:SoftGlue<a class="headerlink" href="#documentation-of-example-circuits-for-synapps-softglue" title="Permalink to this headline">¶</a></h1>
     51<h1>Documentation of Example Circuits for synApps SoftGlue<a class="headerlink" href="#documentation-of-example-circuits-for-synapps-softglue" title="Permalink to this headline">¶</a></h1>
    5252<p id="index-0">Example circuits for use in the
    5353<a class="reference external" href="http://www.aps.anl.gov/bcda/synApps">synApps</a>
     
    7777  <h3><a href="#">Table Of Contents</a></h3>
    7878  <ul>
    79 <li><a class="reference internal" href="#">Documentation of Example Circuits for synApps:SoftGlue</a><ul>
     79<li><a class="reference internal" href="#">Documentation of Example Circuits for synApps SoftGlue</a><ul>
    8080<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
    8181</ul>
  • softGlue_examples/build/html/programmable_pulse_train/index.html

    r873 r876  
    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="prev" title="Documentation of Example Circuits for synApps:SoftGlue" href="../index.html" />
     29    <link rel="prev" title="Documentation of Example Circuits for synApps SoftGlue" href="../index.html" />
    3030  </head>
    3131  <body>
     
    3737             accesskey="I">index</a></li>
    3838        <li class="right" >
    39           <a href="../index.html" title="Documentation of Example Circuits for synApps:SoftGlue"
     39          <a href="../index.html" title="Documentation of Example Circuits for synApps SoftGlue"
    4040             accesskey="P">previous</a> |</li>
    4141        <li><a href="../index.html">softglueexamples 2012-06 documentation</a> &raquo;</li>
     
    8787  <h4>Previous topic</h4>
    8888  <p class="topless"><a href="../index.html"
    89                         title="previous chapter">Documentation of Example Circuits for synApps:SoftGlue</a></p>
     89                        title="previous chapter">Documentation of Example Circuits for synApps SoftGlue</a></p>
    9090  <h3>This Page</h3>
    9191  <ul class="this-page-menu">
     
    117117             >index</a></li>
    118118        <li class="right" >
    119           <a href="../index.html" title="Documentation of Example Circuits for synApps:SoftGlue"
     119          <a href="../index.html" title="Documentation of Example Circuits for synApps SoftGlue"
    120120             >previous</a> |</li>
    121121        <li><a href="../index.html">softglueexamples 2012-06 documentation</a> &raquo;</li>
  • softGlue_examples/build/html/searchindex.js

    r873 r876  
    1 Search.setIndex({objects:{},terms:{set:1,synapp:0,show:1,indic:0,down:1,tabl:0,index:0,shown:0,wai:1,clock: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:{set:1,synapp:0,show:1,indic:0,down:1,tabl:0,index:0,shown:0,wai:1,clk:1,definit:1,content:0,softglu:0,program:1,build:1,dff:1,circuit:[0,1],fpga:0,resolut:1,train:[0,1],output:1,preset:1,counter:1,search:0,document:0,off:1,frequenc:1,clock:1,project:0,exampl:0,thi:1,time:1,programm:[0,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"]})
  • softGlue_examples/source/README

    • Property svn:keywords changed from Id to Date Revision Author HeadURL Id
    r872 r876  
    22
    33===========================================
    4 Coaching on the use of reStructuredText
     4Adding new examples
    55===========================================
    66
    7 .. note:: Web documentation available at:
    8    https://subversion.xor.aps.anl.gov/bcdaext/pulse_train_doc/build/html/index.html
     7To 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
     19setting the subversion mime type of a file
     20++++++++++++++++++++++++++++++++++++++++++
     21
     22=========  ===============================================
     23extension  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
     30Any of these commands may be useful at times when adding
     31new examples so the HTML files display properly from the
     32subversion 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
     46Additional Coaching on the use of reStructuredText
     47---------------------------------------------------
    948
    1049This is a just an example of writing the documentation using sphinx. [#]_
    11 It is easy to edit the documentation since it is text.  You can find the built :index:`html` documentation in
     50It is easy to edit the documentation since it is text. 
     51You can find the built :index:`html` documentation in
    1252``build/html/index.html``.  To build the documentation, you need to
    13 be in the ``sphinxdoc`` (or whatever you name it) directory, then type::
     53be in the ``softGlue_examples`` (or whatever you name it) directory, then type::
    1454
    1555        make html
     
    2666        make latexpdf
    2767
    28 and then pick that up in ``build/latex/pulse_train.pdf``.  [#]_
     68and then pick that up in ``build/latex/build/latex/softglueexamples.pdf``.  [#]_
    2969
    3070.. [#] Sphinx uses Python.  You may want to build this on an APS
     
    3878---------------------------------------
    3979
    40 You can pull this example from its subversion repo and add it
    41 to your project by going to the desired directory
    42 (perhaps the TOP directory for your support) and exporting from this
     80You can pull this example from its subversion repo and edit it
     81by going to your chosen parent directory and checking out from this
    4382subversion repository::
    4483
    45    svn export https://subversion.xor.aps.anl.gov/bcdaext/pulse_train_doc sphinxdoc
     84   svn co https://subversion.xor.aps.anl.gov/bcdaext/softGlue_examples softGlue_examples
    4685
    4786
  • softGlue_examples/source/conf.py

    r872 r876  
    9494# a list of builtin themes.
    9595html_theme = 'default'
     96#html_theme = 'agogo'
     97#html_theme = 'sphinxdoc'        # better code displays, horizontal scrollbars as-needed
    9698
    9799# Theme options are theme-specific and customize the look and feel of a theme
  • softGlue_examples/source/index.rst

    r872 r876  
    22
    33======================================================
    4 Documentation of Example Circuits for synApps:SoftGlue
     4Documentation of Example Circuits for synApps SoftGlue
    55======================================================
    66
Note: See TracChangeset for help on using the changeset viewer.