[Grok-dev] IMPORTANT NOTICE! Community documentation is migrating from Plone to Sphinx

Sebastian Ware sebastian at urbantalk.se
Fri Nov 5 15:27:33 EDT 2010


To all documentation loving grok-men out there. The kettle is boiling, bring your ground beans.

We are moving the community docs to a Sphinx site. The setup is done and we need help migrating docs. When enough docs are moved, we will complete the migration.

1 Install Sphinx

2 Check-out grok-doc

  hg clone http://bitbucket.org/jhsware/grok-doc/

3 Optionally create another Spinx project and copy
  "Makefile" to the grok-doc root 

  sphinx-quickstart

4 Start contributing!

You will find an unofficial outline in the root directory, it explains of the file structure is intended to be. You can find some docs already in the source-tree. 

If you are creating a multipage document, put it in a separate folder and add an index.rst which should be referenced from from the parent folder index.rst.

Please help and migrate howtos and tutorials. Send me a diff file and I will make sure someone merges it.

Mvh Sebastian



More information about the Grok-dev mailing list