[Grok-dev] ReST reference

[Uli Fouquet]

Hi there,

tonight I built a version of the Grok reference from pure ReST files.
The conversion to ReST and generation of HTML was done using the current
docutils.

The sources are in this branch::

  http://svn.zope.org/Sandbox/ulif/grok-reference-with-rest/

See doc/reference/README.txt for more information.

Some notes:

 - Currently there is no PDF support (they are working on that).

 - The toolchain is using the sphinx-package from docutils, which
   requires Python2.5.

 - I had to patch the stock sphinx-package to generate non-Python docs
   (i.e. docs, which are not the original Python documentation). The 
   patch is included in the above branch (see README.txt in
   doc/reference)

 - Yet didn't tweak the search function, which still presents the
   original Python search (the search is static/JavaScript only, no 
   server functionality).

 - The ReST files could also be rendered otherwise, but there are lots
   of special 'tags'.

 - The documentation framework could in principle also serve other 
   documentation, tutorials, howtos etc. It was built for that.

 - See the README.txt in the above branch's doc/reference for deeper 
   insights on how to build the reference.

 - Maybe one could build the reference easier using a new ``mkhowto``
   script, but I didn't find one for ReST/Python2.5.

Ah, yes, it looks like this::

   https://gf1.gnufix.de/~uli/grok/reference/

Kind regards,

-- 
Uli