Fwd: Help document Plone's API

---------- Forwarded message ----------
From: Mikko Ohtamaa <mikko-75aZqqp77KCaMPzRcYMCawC/[email protected]>
Date: 2009/5/26
Subject: Re: [Plone-docs] Help document Plone's API
To: Israel Saeta Pérez <[email protected]>
Cc: Martin Aspeli <[email protected]>, [email protected]


>> That's a different issue again. It'd be great to expose this. However,
>> there's too many doctests and interfaces and no structure (other than
>> the arbitrary package structure of the code they're bundled with)
>> that'll help people find what they need. If you look at that mindmap,
>> many of the groupings sit across three or four packages.

I think we can still package "Plone API developer manual" as Sphinx
friendly as possible. I guess Python itself uses bunch of text files
to describe its API - now Python 2.6 uses Sphinx at
http://docs.python.org/ too

I once came across this useful reST plug in:

http://pypi.python.org/pypi/ulif.rest/

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.

-Mikko

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