Re: Fwd: Help document Plone's API

Vincent Fretin <[email protected]>
Newsgroups gmane.comp.web.zope.plone.documentation
Message-ID <[email protected]>
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.

Regards
-- 
Vincent Fretin

------------------------------------------------------------------------------
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
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.