[Twisted-Python] lore

[James Y Knight]

On May 17, 2006, at 1:01 PM, glyph at divmod.com wrote:
> FWIW, I really wouldn't be opposed to ReST as a _format_, as long  
> as it fit into the rest of the toolchain.  If anyone else shares  
> james' dislike of extremely limited HTML as an input format and  
> user interface[1] to the documentation system, writing an input  
> plugin for lore to recognize it would be a good first step.

JP/Exarkun is against ReST as an input format for the documentation  
system. Writing an input plugin for lore to recognize it isn't a good  
first step, getting agreement that writing such a plugin would be  
Good is a good first step. From http://twistedmatrix.com/trac/ticket/ 
1515:
> All documentation for all Twisted projects should use lore. There  
> should only be one source format for documentation: even though we  
> could write a ReST input driver, doing so would defeat a large  
> portion of the purpose of lore, which is to make it easy to write  
> and maintain documentation (requiring everyone to learn lore xhtml  
> and ReST is harder than requiring everyone to learn lore xhtml).
I disagree with that conclusion, but have given up arguing the point.  
If there are others who support my view, now would be a good time to  
speak up. You of course get extra bonus points if you've actually  
contributed to documentation in twisted.

James