From 9e1447779d61d52c5dc91f92cdaf050566f96e2e Mon Sep 17 00:00:00 2001 From: richard Date: Mon, 24 Jun 2002 23:06:58 +0000 Subject: [PATCH] Docco changes and new build system using the New Improved tool supplied with docutils. git-svn-id: http://svn.roundup-tracker.org/svnroot/roundup/trunk@813 57a73879-2fb5-44c3-a270-3262357dd7e2 --- doc/Makefile | 14 ++++++++++++++ doc/build_html.py | 31 ------------------------------- doc/customizing.txt | 16 ++++++++-------- doc/installation.txt | 11 ++++++++--- doc/upgrading.txt | 5 +++-- 5 files changed, 33 insertions(+), 44 deletions(-) create mode 100644 doc/Makefile delete mode 100755 doc/build_html.py diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000..1f22b0e --- /dev/null +++ b/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 $< $@ + diff --git a/doc/build_html.py b/doc/build_html.py deleted file mode 100755 index eb4a3f9..0000000 --- a/doc/build_html.py +++ /dev/null @@ -1,31 +0,0 @@ -#!/usr/bin/env python - -""" -:Author: David Goodger -:Contact: goodger@users.sourceforge.net -:Revision: $Revision: 1.2 $ -:Date: $Date: 2002-05-06 23:38:07 $ -:Copyright: This module has been placed in the public domain. - -A minimal front-end to the Docutils Publisher. - -This module takes advantage of the default values defined in `publish()`. -""" - -import sys, os.path -from docutils.core import publish -from docutils import utils - -if len(sys.argv) < 2: - print >>sys.stderr, 'I need at least one filename' - sys.exit(1) - -reporter = utils.Reporter(2, 4) - -for file in sys.argv[1:]: - name, ext = os.path.splitext(file) - dest = '%s.html'%name - print >>sys.stderr, '%s -> %s'%(file, dest) - publish(writer_name='html', source=file, destination=dest, - reporter=reporter) - diff --git a/doc/customizing.txt b/doc/customizing.txt index 0288dfc..bc6b140 100644 --- a/doc/customizing.txt +++ b/doc/customizing.txt @@ -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 ~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/installation.txt b/doc/installation.txt index f44998f..b55378f 100644 --- a/doc/installation.txt +++ b/doc/installation.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:: diff --git a/doc/upgrading.txt b/doc/upgrading.txt index 4fe589f..f7aba78 100644 --- a/doc/upgrading.txt +++ b/doc/upgrading.txt @@ -23,7 +23,7 @@ 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/templates/classic/instance_config.py @@ -31,7 +31,7 @@ and:: /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 -- 2.30.2