Re: Fwd: Help document Plone's API

Clayton Parker <clayton-qEDqLqPM/[email protected]>
Newsgroups gmane.comp.web.zope.plone.documentation
Message-ID <[email protected]>
On May 26, 2009, at 10:17 PM, Martin Aspeli wrote:

> Mikko Ohtamaa wrote:
>
>> <snip>
>>
>> It adds bag of reST gimmics, including Python highlighting. I
>> sincerely recommend we use something similar for API manual. We could
>> even add some Plone specific tags.
>
> I sincerely hate reST. :)
>
> Half the time I upload something to PyPI, the pages get totally  
> screwed
> up. It's about as people-unfriendly as we get in this community. :)

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

That being said, it is quite powerful once you are used to it, but I  
still prefer writing docs in markdown or something similar.

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
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.