Changeset 872


Ignore:
Timestamp:
Jun 5, 2012 3:40:40 PM (10 years ago)
Author:
jemian
Message:

refactoring

Location:
softGlue_examples
Files:
8 added
2 edited
3 moved

Legend:

Unmodified
Added
Removed
  • softGlue_examples/source/conf.py

    r863 r872  
    4141
    4242# General information about the project.
    43 project = u'pulse_train'
    44 copyright = u'2012, Kurt Goetze, BCDA'
     43project = u'softglueexamples'
     44author = u'Kurt Goetze, BCDA'
     45copyright = u'2012, ' + author
    4546
    4647# The version info for the project you're documenting, acts as replacement for
     
    5152version = '2012-06'
    5253# The full version, including alpha/beta/rc tags.
    53 release = '2012-06'
     54release = version
    5455
    5556# The language for content autogenerated by Sphinx. Refer to documentation
     
    165166
    166167# Output file base name for HTML help builder.
    167 htmlhelp_basename = 'pulse_traindoc'
     168htmlhelp_basename = project + 'doc'
    168169
    169170
     
    184185# (source start file, target name, title, author, documentclass [howto/manual]).
    185186latex_documents = [
    186   ('index', 'pulse_train.tex', u'pulse\\_train Documentation',
    187    u'Kurt Goetze, BCDA', 'manual'),
     187  ('index', project + '.tex', project + u' Documentation',
     188   author, 'howto'),
    188189]
    189190
     
    214215# (source start file, name, description, authors, manual section).
    215216man_pages = [
    216     ('index', 'pulse_train', u'pulse_train Documentation',
    217      [u'Kurt Goetze, BCDA'], 1)
     217    ('index', project, project + u' Documentation',
     218     [author], 1)
    218219]
    219220
     
    228229#  dir menu entry, description, category)
    229230texinfo_documents = [
    230   ('index', 'pulse_train', u'pulse_train Documentation',
    231    u'Kurt Goetze, BCDA', 'pulse_train', 'One line description of project.',
     231  ('index', project, project + u' Documentation',
     232   author, project, 'softGlue example circuits.',
    232233   'Miscellaneous'),
    233234]
  • softGlue_examples/source/index.rst

    r867 r872  
    11.. $Id$
    22
    3 ===========================================
    4 Documentation of Programmable pulse train
    5 ===========================================
     3======================================================
     4Documentation of Example Circuits for synApps:SoftGlue
     5======================================================
    66
    7 .. figure:: adl_screens.png
     7.. index::
     8   !synApps
     9   !SoftGlue
    810
    9    the figure caption says "Three MEDM screens"
    10 
    11 .. this is a bit fancier for a figure, using a table
    12    to get a fancier title bar since the figure caption
    13    above looks very plain.
    14 
    15 +-----------------+------------------------------+
    16 | This table is actually a Figure!               |
    17 +=================+==============================+
    18 |  Dff Q output:  |  .. image:: square_wave.png  |
    19 +-----------------+------------------------------+
    20 
    21 * Time resolution set by clock frequency (clk).
    22 * Down Counter 1 PRESET programs On Time.
    23 * Down Counter 2 PRESET programs Off Time.
    24 
     11Example circuits for use in the
     12`synApps <http://www.aps.anl.gov/bcda/synApps>`_
     13`SoftGlue <http://www.aps.anl.gov/bcda/synApps/softGlue/softGlue.html>`_
     14FPGA project are shown.
    2515
    2616
     
    2818
    2919.. toctree::
    30    :maxdepth: 3
    31    :glob:
     20   :maxdepth: 1
    3221   
    33    coaching*
     22   programmable_pulse_train/index
    3423
    3524Indices and tables
Note: See TracChangeset for help on using the changeset viewer.