source: softGlue_examples/source/adding_examples.rst @ 976

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

Replaced old publish instructions in light of the new system.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Revision Author HeadURL Id
File size: 1.7 KB
Line 
1.. $Id: adding_examples.rst 976 2012-06-25 21:34:17Z 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
32setting the subversion mime type of a file
33++++++++++++++++++++++++++++++++++++++++++
34
35=========  ========================================
36extension  command
37=========  ========================================
38``.html``  ``svn ps svn:mime-type text/html``
39``.css``   ``svn ps svn:mime-type text/css``
40``.js``    ``svn ps svn:mime-type text/javascript``
41=========  ========================================
42
43Publishing new content as HTML
44++++++++++++++++++++++++++++++
45
46#) % su svnbcext
47#) % cd /home/joule/SVN/subversion/bcdaext/projects/softGlue_examples
48#) % publish.sh
Note: See TracBrowser for help on using the repository browser.