Skip to content

Commit e90bbab

Browse files
author
Justus Pendleton
committed
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.
1 parent 2d12cda commit e90bbab

File tree

3 files changed

+9
-4
lines changed

3 files changed

+9
-4
lines changed

README.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,14 @@ directory.
3131
Upgrading
3232
=========
3333
For upgrading instructions, please see upgrading.txt in the "doc" directory.
34-
34+
3535

3636
Usage and Other Information
3737
===========================
3838
See the index.txt file in the "doc" directory.
39+
The *.txt files in the "doc" directory are written in reStructedText. If
40+
you have rst2html installed (part of the docutils suite) you can convert
41+
these to HTML by running "make html" in the "doc" directory.
3942

4043

4144
License

doc/Makefile

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ SOURCE = announcement.txt customizing.txt developers.txt FAQ.txt features.txt \
1010
COMPILED := $(SOURCE:.txt=.html)
1111
WEBHT := $(SOURCE:.txt=.ht)
1212

13-
all: ${COMPILED} ${WEBHT}
13+
html: ${COMPILED}
14+
ht: ${WEBHT}
15+
all: html ht
1416

1517
website: ${WEBHT}
1618
cp *.ht ${WEBDIR}

doc/installation.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Installing Roundup
33
==================
44

5-
:Version: $Revision: 1.128 $
5+
:Version: $Revision: 1.129 $
66

77
.. contents::
88
:depth: 2
@@ -160,7 +160,7 @@ for these locations, eg. being root on unix::
160160

161161
If you would like to place the Roundup scripts in a directory other
162162
than ``/usr/bin``, then specify the preferred location with
163-
``--install-script``. For example, to install them in
163+
``--install-scripts``. For example, to install them in
164164
``/opt/roundup/bin``::
165165

166166
python setup.py install --install-scripts=/opt/roundup/bin

0 commit comments

Comments
 (0)