[Grok-doc] Migration of comunity docs has stalled...

Vincent Fretin vincent.fretin at gmail.com
Mon Jan 3 10:34:50 EST 2011


I added my script in grok-doc/buildout.cfg
bin/buildout generates a bin/build.sh script that build the html and pdf
file and copy it to ~/public_html/grokdocs (configurable via the
document_root option in buildout.cfg)
I added a link to the pdf in the docindex.template file. I saved the
logo.gif to png to include it in the pdf, but we need a HD version.
The buildout add a cronjob to the user crontab and run every hour.
Somebody now need to run the buildout on the server and serve the
~/public_html/grokdocs via apache.


On Mon, Jan 3, 2011 at 1:05 PM, Uli Fouquet <uli at gnufix.de> wrote:

> Hi there,
> Jan-Wijbrand Kolman wrote:
> > On 1/3/11 12:28 PM, Uli Fouquet wrote:
> > Yes I have. I'll look into this (I know I promised before, twice...
> > sorry about the "latency").
> No worries, please! Another problem that might arise with the build.sh
> script in the grok trunk:
> I meanwhile updated major parts of the reference documentation in
> grok/trunk/doc/reference. I think these reference docs should go apart
> from community docs, so the 'reference' link in the community docs
> should go to some foreseeable but external URL (maybe:
> http://packages.python.org/grok?)
> These reference docs now also depend on Sphinx (and grok, due to lots of
> auto-documenting) only. The build process therefore has changed and can
> be triggered by the usual `sphinx-build` command (or `grokdoc2html|
> latex` which are wrappers around `sphinx-build`). This `sphinx-build`
> command, however, which can be buildout-generated, can change over time
> with new versions of Sphinx. So I'd rather love to see a script that
> also generates the `sphinx-build` command freshly when run, especially,
> when it comes to cron-triggered nightly builds. For single-time use one
> could trigger the command manually (for instance when releasing a new
> Grok version).
> The reference docs now also provide some doctests to make sure the given
> examples really work. This, however, is still some work to do, as test
> setup can become hairy in Sphinx envs, but most simple examples can be
> tested already running the sphinx doctest builder. Maybe we want to run
> the doctest-builder as well in the long run?
> Just my 2c.
> Best regards,
> --
> Uli
> _______________________________________________
> grok-doc mailing list
> grok-doc at zope.org
> https://mail.zope.org/mailman/listinfo/grok-doc
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mail.zope.org/pipermail/grok-doc/attachments/20110103/ba771af5/attachment.html 

More information about the grok-doc mailing list