Contributing to these Docs

Trying to figure out a solution to this documentation is not easy since the packages are all over. Any feedback, better solutions, reworking, document contribution would be much appreciated.

I created a buildout that can generate these docs based on the zopeskel source. On build it pulls the README.txt from the root of the template directory for each product. To update the docs for a particular product, simply update your README.txt to be sane.

To re/generate the docs, simply run the buildout and then run the customized htmlbuild script in the docs folder.

This doc was generated from a branch of the zopeskel package so things may be different in the source - it’s just a starting point.

Reference: A buildout to run sphinx with zopeskel

This is the buildout I used to hook up sphinx to zopeskel, as well as do dev. It will be much more useful in the future if any of the code is actually linked up. To edit the docs, run this buildout then cd into parts/docs/zopeskel-docs/source to edit any documents. (Note that template docs will be automatically overwritten the next time you run build). To run the build, just run ./htmlbuild.

[buildout]

parts +=
    zopeskel
    sphinxbuilder
    docs

extensions = mr.developer
sources = sources
auto-checkout =
    ZopeSkel
    zopeskel.webui

[versions]
Sphinx = 0.6.4

[sources]
ZopeSkel            = svn https://svn.plone.org/svn/collective/ZopeSkel/branches/nate-hosting
zopeskel.webui      = svn https://svn.plone.org/svn/collective/zopeskel.webui/trunk/

[docs]
recipe = infrae.subversion
urls =
    https://svn.plone.org/svn/collective/ZopeSkel/branches/zopeskel-docs zopeskel-docs

[zopeskel]
recipe = zc.recipe.egg
eggs = ZopeSkel
       zopeskel.webui


[sphinxbuilder]
recipe = collective.recipe.sphinxbuilder
interpreter = ${buildout:directory}/bin/zopepy
eggs = ${zopeskel:eggs}