source: softGlue_examples/source/adding_examples.rst @ 977

Last change on this file since 977 was 977, checked in by mooney, 10 years ago

Added svn checkout details

  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Revision Author HeadURL Id
File size: 2.0 KB
Line 
1.. $Id: adding_examples.rst 977 2012-06-25 21:44:43Z mooney $
2
3===========================================
4Adding new examples
5===========================================
6
7To :index:`!add new examples`, follow these steps:
8
9#. make a new subdirectory under ``source/``
10#. copy all documentation files into this new subdirectory
11#. copy ``programmable_pulse_train/index.rst`` 
12   into this new subdirectory
13#. edit the new ``index.rst`` file to show the
14   images and text for this new example
15#. edit ``source/index.rst`` and add a reference to
16   the new directory in the ``toctree`` under
17   ``programmable_pulse_train/index``
18#. in ``source``, add the new directory to subversion
19#. in ``source/..`` (parent directory), type ``make html`` 
20   to rebuild the web site
21#. it may be necessary to tell subversion the mime
22   type of the html file(s), see below
23#. in the same directory, do a subversion checkin: 
24   ``svn ci -m "new example"``
25
26
27.. note::  You must have the "sphinx-build" command (and possibly other related
28        commands) in your path.  At APS, this command can be found in
29        ``/APSshare/epd/<arch>/bin``. Also note that this is part of the Enthought
30        Python distribution, so it doesn't work on solaris-sparc.
31
32.. note::
33
34        The above procedure presumes you have checked out a copy of
35        softGlue_examples from the subversion repository.  If you have not, the following
36        command will do it:
37       
38        ``svn co https://subversion.xor.aps.anl.gov/bcdaext/softGlue_examples softGlue_examples``
39
40setting the subversion mime type of a file
41++++++++++++++++++++++++++++++++++++++++++
42
43=========  ========================================
44extension  command
45=========  ========================================
46``.html``  ``svn ps svn:mime-type text/html``
47``.css``   ``svn ps svn:mime-type text/css``
48``.js``    ``svn ps svn:mime-type text/javascript``
49=========  ========================================
50
51Publishing new content as HTML
52++++++++++++++++++++++++++++++
53
54#) % su svnbcext
55#) % cd /home/joule/SVN/subversion/bcdaext/projects/softGlue_examples
56#) % publish.sh
Note: See TracBrowser for help on using the repository browser.