Changeset 872

Timestamp:

Jun 5, 2012 3:40:40 PM (11 years ago)

Author:

jemian

Message:

refactoring

Location:

softGlue_examples

Files:

• .project (added)
• .pydevproject (added)
• .settings (added)
• .settings/org.eclipse.core.resources.prefs (added)
• README (added)
• build (added)
• source/README (moved) (moved from softGlue_examples/source/coaching1.rst)
• source/conf.py (modified) (6 diffs)
• source/index.rst (modified) (2 diffs)
• source/programmable_pulse_train (added)
• source/programmable_pulse_train/adl_screens.png (moved) (moved from softGlue_examples/source/adl_screens.png)
• source/programmable_pulse_train/index.rst (added)
• source/programmable_pulse_train/square_wave.png (moved) (moved from softGlue_examples/source/square_wave.png)

softGlue_examples/source/conf.py

@@ -41 +41 @@
 
 # General information about the project.
-project = u'pulse_train'
-copyright = u'2012, Kurt Goetze, BCDA'
+project = u'softglueexamples'
+author = u'Kurt Goetze, BCDA'
+copyright = u'2012, ' + author
 
 # The version info for the project you're documenting, acts as replacement for
@@ -51 +52 @@
 version = '2012-06'
 # The full version, including alpha/beta/rc tags.
-release = '2012-06'
+release = version
 
 # The language for content autogenerated by Sphinx. Refer to documentation
@@ -165 +166 @@
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'pulse_traindoc'
+htmlhelp_basename = project + 'doc'
 
 
@@ -184 +185 @@
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'pulse_train.tex', u'pulse\\_train Documentation',
-   u'Kurt Goetze, BCDA', 'manual'),
+  ('index', project + '.tex', project + u' Documentation',
+   author, 'howto'),
 ]
 
@@ -214 +215 @@
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'pulse_train', u'pulse_train Documentation',
-     [u'Kurt Goetze, BCDA'], 1)
+    ('index', project, project + u' Documentation',
+     [author], 1)
 ]
 
@@ -228 +229 @@
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'pulse_train', u'pulse_train Documentation',
-   u'Kurt Goetze, BCDA', 'pulse_train', 'One line description of project.',
+  ('index', project, project + u' Documentation',
+   author, project, 'softGlue example circuits.',
    'Miscellaneous'),
 ]

softGlue_examples/source/index.rst

@@ -1 +1 @@
 .. $Id$
 
-===========================================
-Documentation of Programmable pulse train
-===========================================
+======================================================
+Documentation of Example Circuits for synApps:SoftGlue
+======================================================
 
-.. figure:: adl_screens.png
+.. index::
+   !synApps
+   !SoftGlue
 
-   the figure caption says "Three MEDM screens"
-
-.. this is a bit fancier for a figure, using a table 
-   to get a fancier title bar since the figure caption
-   above looks very plain.
-
-+-----------------+------------------------------+
-| This table is actually a Figure!               |
-+=================+==============================+
-|  Dff Q output:  |  .. image:: square_wave.png  |
-+-----------------+------------------------------+
-
-* Time resolution set by clock frequency (clk).
-* Down Counter 1 PRESET programs On Time.
-* Down Counter 2 PRESET programs Off Time.
-
+Example circuits for use in the 
+`synApps <http://www.aps.anl.gov/bcda/synApps>`_
+`SoftGlue <http://www.aps.anl.gov/bcda/synApps/softGlue/softGlue.html>`_ 
+FPGA project are shown.
 
 
@@ -28 +18 @@
 
 .. toctree::
-   :maxdepth: 3
-   :glob:
+   :maxdepth: 1
    
-   coaching*
+   programmable_pulse_train/index
 
 Indices and tables