[Zope-dev] docs.zope.org automation

Martin Aspeli optilude+lists at gmail.com
Mon Aug 2 10:46:03 EDT 2010


On 2 August 2010 22:40, Jens Vagelpohl <jens at dataflake.org> wrote:
> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA1
>
> On 8/2/10 16:36 , Stephan Richter wrote:
>> On Monday, August 02, 2010, Jens Vagelpohl wrote:
>>> 'll have to look at that. Currently, the documentation builder does not
>>> do any introspection on the package itself, mostly because I do not want
>>> to fully install the package and pull in all dependencies. Maybe there's
>>> a simple way that does not require full installation.
>>
>> I agree. This does not build the package:
>>
>> python setup.py --long-description
>
> Thanks for the hint, I'll try that. Can you give me a sample package
> where the long description is supposed to be the main documentation? And
> what's the output from that? If it's ReST I'd have to find a way to
> convert it to HTML on the fly... <sigh>

z3c.form, I'd guess. :)

For other examples, look at e.g. z3c.caching, plone.caching or plone.testing.

You can do:

$ python setup.py --long-description | rst2html.py > doc.html

to create an HTML file.

Martin


More information about the Zope-Dev mailing list