Ovreview documentation.

[David Jones]

(prompted by an off-list e-mail) I've added an overview of the GISTEMP
algorithm in:

http://code.google.com/p/ccc-gistemp/source/browse/trunk/doc/overview.txt

If typeset it could fit on two-sides of A4.

Comments welcome.

drj

[John Keyes]

Hi David,

I like the idea, a good overview should be high on the
priority list IMO. It provides a nice entry point for people.

I took your overview and reformatted it with some
very basic Markdown[1]. This allows you to generate
HTML documentation very easily (see attached overview.html).
Using that HTML as source, I then generated a PDF using
pisa[2] (it depends on Reportlab[3] and html5lib[4]) (see
attached overview.pdf).

I also attached the overview Markdown (overview.txt.md) for reference.

I didn't spend much time refining the formatting, I just wanted
to give you an idea of some tools that may be useful.

Cheers,
-John

[1] http://pypi.python.org/pypi/Markdown
[2] http://pypi.python.org/pypi/pisa/
[3] http://pypi.python.org/pypi/reportlab/
[4] http://pypi.python.org/pypi/html5lib

> --
> You received this message because you are subscribed to the Google Groups "CCC GISTEMP discussion" group.
> To post to this group, send email to ccc-giste...@googlegroups.com.
> To unsubscribe from this group, send email to ccc-gistemp-dis...@googlegroups.com.
> For more options, visit this group at http://groups.google.com/group/ccc-gistemp-discuss?hl=en.
>
>