annotate doc/Makefile @ 3949:29dfb873b32e

Small documentation cleanup Tweak the doc makefile to make it easier to build just the HTML docs and add a note to README.txt explaining how to do this for users that would prefer to read local docs in their web browser.
author Justus Pendleton <jpend@users.sourceforge.net>
date Fri, 23 Nov 2007 20:56:02 +0000
parents 068b3d7d4279
children 257b4eab3bb2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3650
77e067e64035 copy over status/priority descriptions from old overview doc
Richard Jones <richard@users.sourceforge.net>
parents: 3526
diff changeset
1 STXTOHTML = rst2html
2409
Richard Jones <richard@users.sourceforge.net>
parents: 2138
diff changeset
2 STXTOHT = rst2ht.py
3526
9b99fff18683 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2910
diff changeset
3 WEBDIR = ../../htdocs/htdocs/doc-1.0
798
faf164ab8ed9 Docco changes.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
4
faf164ab8ed9 Docco changes.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
5 SOURCE = announcement.txt customizing.txt developers.txt FAQ.txt features.txt \
1839
06f5b36b201b Fix a couple of failures in mysql backend unit tests.
Richard Jones <richard@users.sourceforge.net>
parents: 1651
diff changeset
6 glossary.txt implementation.txt index.txt design.txt mysql.txt \
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents: 1875
diff changeset
7 installation.txt upgrading.txt user_guide.txt admin_guide.txt \
3526
9b99fff18683 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2910
diff changeset
8 postgresql.txt tracker_templates.txt
798
faf164ab8ed9 Docco changes.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
9
faf164ab8ed9 Docco changes.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
10 COMPILED := $(SOURCE:.txt=.html)
2409
Richard Jones <richard@users.sourceforge.net>
parents: 2138
diff changeset
11 WEBHT := $(SOURCE:.txt=.ht)
798
faf164ab8ed9 Docco changes.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
12
3949
29dfb873b32e Small documentation cleanup
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3756
diff changeset
13 html: ${COMPILED}
29dfb873b32e Small documentation cleanup
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3756
diff changeset
14 ht: ${WEBHT}
29dfb873b32e Small documentation cleanup
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3756
diff changeset
15 all: html ht
2409
Richard Jones <richard@users.sourceforge.net>
parents: 2138
diff changeset
16
Richard Jones <richard@users.sourceforge.net>
parents: 2138
diff changeset
17 website: ${WEBHT}
Richard Jones <richard@users.sourceforge.net>
parents: 2138
diff changeset
18 cp *.ht ${WEBDIR}
3756
068b3d7d4279 images for user guide
Richard Jones <richard@users.sourceforge.net>
parents: 3650
diff changeset
19 cp -r images ${WEBDIR}
798
faf164ab8ed9 Docco changes.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
20
faf164ab8ed9 Docco changes.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
21 %.html: %.txt
1304
61ad556cfc8d working toward 0.5.2 release
Richard Jones <richard@users.sourceforge.net>
parents: 1249
diff changeset
22 ${STXTOHTML} --report=warning -d $< $@
798
faf164ab8ed9 Docco changes.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
23
2409
Richard Jones <richard@users.sourceforge.net>
parents: 2138
diff changeset
24 %.ht: %.txt
Richard Jones <richard@users.sourceforge.net>
parents: 2138
diff changeset
25 ${STXTOHT} --report=warning -d $< $@
Richard Jones <richard@users.sourceforge.net>
parents: 2138
diff changeset
26
1091
d870139aeb5c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
27 clean:
d870139aeb5c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
28 rm -f ${COMPILED}

Roundup Issue Tracker: http://roundup-tracker.org/