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

OK, good enough for now

File:
1 edited

Legend:

Unmodified
Added
Removed
  • pulse_train_doc/source/coaching1.rst

    r863 r865  
    88   http://subversion.xor.aps.anl.gov/bcdaext/pulse_train_doc/build/html/index.html
    99
    10 This is a just an example of writing the documentation using sphinx.
    11 It is easy.  You can find the built :index:`html` documentation in
     10This is a just an example of writing the documentation using sphinx. [#]_
     11It is easy to edit the documentation since it is text.  You can find the built :index:`html` documentation in
    1212``build/html/index.html``.  To build the documentation, you need to
    13 be in the ``doc`` directory, then type::
     13be in the ``sphinxdoc`` (or whatever you name it) directory, then type::
    1414
    1515        make html
     
    2020        make clean
    2121        make html
    22        
     22
     23.. [#] Sphinx uses Python.  You may want to build this on an APS
     24   SunOS or linux computer.  If so, you'll need to make sure
     25   that the ``/APSshare/epd/{architecture_choice}/bin`` directory
     26   is on your executable path.
     27
    2328SVN export this example documentation
    2429---------------------------------------
Note: See TracChangeset for help on using the changeset viewer.