From a28da3bd70709c10557995fda3ace5e920e40bb2 Mon Sep 17 00:00:00 2001 From: benoitc Date: Thu, 17 Jun 2010 18:28:22 +0200 Subject: [PATCH] quick README to generate documentation. fix issue #62. --- doc/README.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 doc/README.rst diff --git a/doc/README.rst b/doc/README.rst new file mode 100644 index 00000000..70c1f848 --- /dev/null +++ b/doc/README.rst @@ -0,0 +1,22 @@ +Generate Documentation +---------------------- + +Requirements +++++++++++++ + +To generate documentation you need to install: + + - Python 2.x >= 2.5 + - jinja2 (http://jinja.pocoo.org/2/) + - docutils (http://docutils.sourceforge.net/) + - compass (http://compass-style.org/) + - compass-960-plugin (http://github.com/chriseppstein/compass-960-plugin) + + +Generate +++++++++ +:: + + $ ./buildweb.py + +Have a look in the file.py for configuration details. \ No newline at end of file