source: softGlue_examples/source/adding_examples.rst @ 976

.. $Id: adding_examples.rst 976 2012-06-25 21:34:17Z mooney $

===========================================
Adding new examples
===========================================

To :index:`!add new examples`, follow these steps:

#. make a new subdirectory under ``source/``
#. copy all documentation files into this new subdirectory
#. copy ``programmable_pulse_train/index.rst`` 
   into this new subdirectory
#. edit the new ``index.rst`` file to show the 
   images and text for this new example
#. edit ``source/index.rst`` and add a reference to 
   the new directory in the ``toctree`` under 
   ``programmable_pulse_train/index``
#. in ``source``, add the new directory to subversion
#. in ``source/..`` (parent directory), type ``make html`` 
   to rebuild the web site
#. it may be necessary to tell subversion the mime 
   type of the html file(s), see below
#. in the same directory, do a subversion checkin:  
   ``svn ci -m "new example"``


.. note::  You must have the "sphinx-build" command (and possibly other related
        commands) in your path.  At APS, this command can be found in
        ``/APSshare/epd/<arch>/bin``. Also note that this is part of the Enthought
        Python distribution, so it doesn't work on solaris-sparc.

setting the subversion mime type of a file
++++++++++++++++++++++++++++++++++++++++++

=========  ========================================
extension  command
=========  ========================================
``.html``  ``svn ps svn:mime-type text/html``
``.css``   ``svn ps svn:mime-type text/css``
``.js``    ``svn ps svn:mime-type text/javascript``
=========  ========================================

Publishing new content as HTML
++++++++++++++++++++++++++++++

#) % su svnbcext
#) % cd /home/joule/SVN/subversion/bcdaext/projects/softGlue_examples
#) % publish.sh