Re: Fwd: Help document Plone's API

On May 27, 2009, at 5:03 AM, Vincent Fretin wrote:

> On Wed, May 27, 2009 at 10:32 AM, Mikko Ohtamaa
> <mikko+plone-75aZqqp77KCaMPzRcYMCawC/[email protected]> wrote:
>>> I also dislike reST. It's terribly strict and quite hard to use for
>>> mere mortals.  I spend a lot of time fixing up reST  
>>> long_descriptions
>>> on collective packages (that aren't mine) just because I can't stand
>>> to see the pages broken :D
>>
>> Check http://pypi.python.org/pypi/collective.checkdocs/0.1.1 for
>> checking reST :)
>
> Hi,
>
> Tarek Ziade added a check distutils command in collective.dist, an
> will be in Python 2.7 I think.
> So you can do:
> python setup.py check --strict
> to check long_description reST.
>
> You can do:
> python setup.py --long-description | rst2html.py > /tmp/foo.html
> and open /tmp/foo.html in your browser too.


I use the following command so that you can see where the errors are  
in the compiled long_description, otherwise you have to hunt the error  
down:

python2.4 setup.py --long-description > /tmp/package.rst &&  
rst2html.py /tmp/package.rst /tmp/package.html && mate /tmp/package.rst

And I alias that to 'descrip_check' because I use it so often (I use  
TextMate on the mac, could easily be sent to another program besides  
'mate')

claytron
-- 
S i x  F e e t  U p ,  I n c .  |  http://www.sixfeetup.com
Phone: +1 (317) 861-5948 x603
clayton-qEDqLqPM/[email protected]
ANNOUNCING the first Plone Immersive Training Experience | Sept.  
10-11-12, 2009
http://www.sixfeetup.com/immerse

------------------------------------------------------------------------------
Register Now for Creativity and Technology (CaT), June 3rd, NYC. CaT 
is a gathering of tech-side developers & brand creativity professionals. Meet
the minds behind Google Creative Lab, Visual Complexity, Processing, & 
iPhoneDevCamp as they present alongside digital heavyweights like Barbarian 
Group, R/GA, & Big Spaceship. http://p.sf.net/sfu/creativitycat-com