Re: Fwd: Help document Plone's API
Mikko Ohtamaa <mikko+plone-75aZqqp77KCaMPzRcYMCawC/[email protected]>
| Newsgroups | gmane.comp.web.zope.plone.documentation |
|---|---|
| Message-ID | <[email protected]> |
> 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 :) reST is terrible and I hate it too. But for writing code documents it's the best tool we have and I hate alternatives even more. But as long as browsers/rich editor/Kupu fail to do <pre> editing in any sane (messed up formatting, missing new lines, double new lines) way I don't like tie idea of writing any code documents in browser WYSIWYG editor. Also, Sphinx seems to be the upcoming de facto standard to document Python. I hope we don't have yet another case here of being unpythonic. Sphinx is also proven technology (python.org). I am not sure how tighly Sphinx and reST are coupled if something better than reST comes up. -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