rSTWeb - reStructuredText Website Generation

Home  
- Documentation
    Tutorial
    Installation
  Download
deutsch  print
Installation

Installation

This document describes how to install the rSTWeb system.

Preliminaries

Of course you must have Python installed. But apart from that you must have the following Python modules installed in order to use rSTWeb:

  1. The Cheetah Templating system, which you may download from http://www.cheetahtemplate.org
  2. The soon to become standard Python docutils, which are available at: http://docutils.sourceforge.net

Please refer to the respective documentation for instructions on how to install these modules.

Installing rSTWeb

This is very easy since at this moment rSTWeb consists of nothing more than one Python script and one default Cheetah template. You may put them anywhere you choose on your system. Just make sure you can execute rstweb.py.

Using rSTWeb

You call rstweb.py from the commandline like this:

rstweb.py site-sources/ site/ template.tmpl

Where site-sources/ is the directory where your sources are and site/ is the directory where the generated html files will be written.

rSTWeb comes with a default template, but you may edit this as you whish.

That's all.

top
This page was generated with rSTWeb, the Sourcecode for this page was written with reStructuredText. Carsten Eckelmann, careck@sourceforge.net [Python Powered] SourceForge.net Logo