Re: Helping out with zope.org
from
"Paul Carduner"
on May 11, 2008 02:35 PM
On Wed, Apr 30, 2008 at 10:39 PM, Jens Vagelpohl <jens@...> wrote:
> As for where the docs could go, apidoc.zope.org holds static Zope 3 docs
> now. My suggestion would be to stick it there. It is hosted on the new Zope
> Foundation-paid server which I am setting up over the next weeks.
>
> To get the data onto the server I suggest either providing me with all the
> information I need to do the auto-generation on the server, or to make the
> autogenerated docs available somewhere so I can pull them in (svn, tarball,
> whatever I can load from the Internet in an automated way). The plan is to
> avoid handing shell access out like candy and have simple automated
> processes instead.
Hi Jens,
I've made good progress on a buildout recipe for generating sphinx
documentation across multiple packages. I've also created a buildout
configuration that pulls in all the different package branches that
I've been working on. Here are the steps for generating the
documentation so far:
svn co svn://svn.zope.org/repos/main/Sandbox/pcardune/z3c.zopedocs
cd z3c.zopedocs
python bootstrap.py
./bin/buildout
./bin/docs
This builds all the relevant html pages in the parts directory. For
this particular buildout configuration, I am building docs for
z3c.form, z3c.formjs, z3c.table, and z3c.recipe.sphinxdoc, so the
sphinx build directories are
parts/docs/z3c.formjs/build/
parts/docs/z3c.table/build/
parts/docs/z3c.form/build/
parts/docs/z3c.recipe.sphinxdoc/build/
I guess for publishing these on the apidoc.zope.org server, I would
build all these documents somewhere on the server and make symlinks to
them from a publicly accessible directory. I've set this up on my own
site here: http://docs.carduner.net/
Let me know if you need anything else. In the mean time, I will
continue working on improving the actual documentation. As soon as
these docs are up, I'll start putting links to them on the zode01
site.
--
Paul Carduner
http://www.carduner.net