← Blog

Help improve Plone's API documentation

Help improve Plone's API documentation

Tweet

Wed 17 October 2007

By aclark

In Blog .

System Message: WARNING/2 (<string>, line 15)

Block quote ends without a blank line; unexpected unindent.

tags: Plone `|image0|`_ I'm travelling from Washington, DC, USA to Mountain View,

System Message: WARNING/2 (<string>, line 16)

Definition list ends without a blank line; unexpected unindent.

CA, USA June 26 - 29 to participate in the 2007 Plone Doccomm Sprint . My main focus will be updating Plone's online API documentation (available at http://api.plone.org ). If you are interested in seeing this done and would like to help, please consider making a donation to help offset the cost of my airfare. In return, I will create and upload API documentation for:

Plone-2.5.3 Archetypes-1.4.4 CMF-1.6.4

and:

Plone-3.0 Archetypes-1.5.0 CMF-2.1.0

I plan to use either epydoc or pudge . Suggestions welcome! For

System Message: WARNING/2 (<string>, line 34)

Block quote ends without a blank line; unexpected unindent.
more information please see:
http://plone.org/development/teams/documentation/documentation-tracker/37 and: http://www.nabble.com/Turn-off-api.plone.org--tf3602743.html#a10064645 (I originally suggested we turn off api.plone.org but that was met with
a resounding "no!")
And without further ado, please consider making a donation! Any amount

System Message: WARNING/2 (<string>, line 41)

Definition list ends without a blank line; unexpected unindent.

is welcome; the goal is $600 USD. I will make an announcement once I've reached it (so people don't give too much).

System Message: ERROR/3 (<string>, line 43)

Unexpected indentation.

Thank You!!!

Docutils System Messages

System Message: ERROR/3 ( /Users/aclark/Developer/blog/content/help-improve-plones-api-documentation.rst , line 6); backlink

System Message: WARNING/2 (<string>, line 48)

Block quote ends without a blank line; unexpected unindent.

Unknown target name: "|image0|".

Comments !

var disqus_identifier = "/2007/10/17/help-improve-plone039s-api-documentation/"; (function() { var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true; dsq.src = 'http://aclark-blog.disqus.com/embed.js'; (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq); })();

Docutils System Messages

System Message: ERROR/3 (<string>, line 48); backlink

Undefined substitution referenced: "image0".

System Message: ERROR/3 (<string>, line 15); backlink

Unknown target name: "|image0|".