Docco changes.

New docco build system using the New Improved tool supplied with docutils.

Author: Richard Jones

doc/Makefile

@@ -0,0 +1,14 @@
+PYTHON = /usr/bin/python2
+STXTOHTML = -c "from docutils.core import publish;publish(writer_name='html')"
+
+SOURCE = announcement.txt customizing.txt developers.txt FAQ.txt features.txt \
+    getting_started.txt glossary.txt implementation.txt index.txt \
+    installation.txt security.txt upgrading.txt user_guide.txt
+
+COMPILED := $(SOURCE:.txt=.html)
+
+all: ${COMPILED}
+
+%.html: %.txt
+	${PYTHON} ${STXTOHTML} -d -v $< $@
+

doc/build_html.py

@@ -2,7 +2,7 @@
 Customising Roundup
 ===================
 
-:Version: $Revision: 1.8 $
+:Version: $Revision: 1.9 $
 
 .. contents::
 
@@ -526,13 +526,13 @@ Repurcussions of changing the instance schema
 If you choose to change_the_instance_schema you will need to ensure the web
 interface knows about it:
 
-   1. Index, item and filter pages for the relevant classes may need to have
-      properties added or removed,
-   2. The default page header relies on the existence of, and some values of
-      the priority, status, assignedto and activity classes. If you change any
-      of these (specifically if you remove any of the classes or their default
-      values) you will need to implement your own pagehead() method in your
-      instance's interfaces.py module.
+1. Index, item and filter pages for the relevant classes may need to have
+   properties added or removed,
+2. The default page header relies on the existence of, and some values of
+   the priority, status, assignedto and activity classes. If you change any
+   of these (specifically if you remove any of the classes or their default
+   values) you will need to implement your own pagehead() method in your
+   instance's interfaces.py module.
 
 Displaying Properties
 ~~~~~~~~~~~~~~~~~~~~~

doc/customizing.txt

@@ -2,7 +2,7 @@
 Installing Roundup
 ==================
 
-:Version: $Revision: 1.12 $
+:Version: $Revision: 1.13 $
 
 .. contents::
 
@@ -66,9 +66,13 @@ later. Download the latest version from http://pybsddb.sourceforge.net/.
 Testing your Python
 -------------------
 
-Run ``"python ./run_tests"`` and make sure there
+Run ``python ./run_tests`` and make sure there
 are no errors.  If there are errors, please let us know!
 
+If the above fails, you may be using the wrong version of python. Try
+``python2 ./run_tests``. If that works, you will need to substitute
+``python2`` for ``python`` in all further commands you use in relation to
+Roundup -- from installation and scripts.
 
 Getting Roundup
 ===============
@@ -79,7 +83,8 @@ Download the latest version from http://roundup.sf.net/.
 Installation
 ============
 
-Set aside 15-30 minutes.
+Set aside 15-30 minutes. Please make sure you're using a supported version of
+Python -- see `testing your python`_.
 
 1. To install the Roundup support code into your Python tree and
    Roundup scripts into /usr/local/bin::

doc/installation.txt

@@ -23,15 +23,15 @@ The new configuration variables are:
 - EMAIL_LEAVE_BODY_UNCHANGED
 - ADD_RECIPIENTS_TO_NOSY
 
-See the sample condfiguration files in::
+See the sample configuration files in::
 
  <roundup source>/roundup/templates/classic/instance_config.py
 
 and::
 
  <roundup source>/roundup/templates/extended/instance_config.py
 
-for information on how they're used.
+and the documentation in customizing_ for information on how they're used.
 
 
 0.4.2 Changes to detectors
@@ -328,3 +328,4 @@ distribution. Make sure you update the ROUNDUP_INSTANCE_HOMES after the
 copy.
 
 
+.. _customizing: customizing.html