[Twisted-Python] how to write a doc for Twisted with Sphinx?

[Glyph Lefkowitz]

On Sep 21, 2011, at 8:31 AM, Kevin Horn wrote:

> Kevin Horn
> 
> On Wed, Sep 21, 2011 at 6:53 AM, Jean-Daniel <jeandaniel.browne at gmail.com> wrote:
> Hello,
> 
> Can we write a doc for Twisted using Sphinx at this point?
> 
> What is the status of the Lore to Sphinx transition project? I could find:
> 
> #4621   lore2sphinx should make pretty links to included files.
> #4586   Code-listings generated by lore2sphinx should include line-numbers
> 
> Is there any other info/update available?
> 
> Currently this is waiting on changes to the Twisted release automation code.
> 
> Docs should still be written using Lore, and then you should check the Lore buildbot to see if they are being translated to Sphinx properly.

Lore is just simple HTML with a few 'class' decorations for features like syntax highlighting (as you can see from the examples) so it should be easy enough to write.  If you want to write the document with Sphinx, someone on the development team would be happy to translate it manually - creating the content is much harder than writing the markup :).

> If you care to take a look at the release automation code, please feel free.

You can see the milestone here:

	<http://twistedmatrix.com/trac/milestone/Lore%20to%20Sphinx>

and the ticket for actually doing the conversion is here:

	<http://twistedmatrix.com/trac/ticket/4500>

there's already some commentary on that ticket explaining what needs to be done next.

-glyph
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://twistedmatrix.com/pipermail/twisted-python/attachments/20110921/d73d3020/attachment.htm