GGI www and documentation scheme
================================

GGI uses of ReST for both the documentation and site.
See docutils.sourceforge.net for more information on ReST.

Generating site contents
------------------------

1. Make sure the 'html' repository is up-to-date
2. Set the GGIWWW environment variable to the http prefix were the site will be
   accessible (defaults to 'http://www.ggi-project.org/')

4. Run::

    python www.py <output dir>

It will populate the output dir with html files.

That's it.

Generating manpages
-------------------

To generate manpages (e.g. just before making a new release)
simply run::

	python manpage.py <filename> <output dir>

where filename is the toplevel documentation file for a
packages (e.g. ggi-core/libggi/doc/libggi.txt)

To generate html manpages, use::

	python html.py <filename> <output dir> <version>

It will create an 'index.html' listing all manpages. 'version'
is the library version for which the manpage is generated. by
default, it will be set to `basename <filename> .txt`-current

For example::

	# generate gii current manpages in tmp/libgii-current
	python html.py ../ggi-core/libgii/doc/libgii.txt tmp/libgii-current

	# generate manpages for version libggi-2.0.2.
	python html.py libggi-2.0.2/doc/libggi.txt \
			ggihtml/documentation/libggi/2.0.2 \
			libggi-2.0.2


