Back in July, there was a long discussion thread regarding Twisted <br>Documentation, and the idea of switching to Sphinx came up. Here's <br>probably the culmination of that thread:<br><br><a href="http://twistedmatrix.com/pipermail/twisted-python/2009-July/020114.html" target="_blank">http://twistedmatrix.com/pipermail/twisted-python/2009-July/020114.html</a><br>
<br>To summarize, Glyph laid out the following items that would need to happen in<br>order for Twisted to move from Lore to another documentation system:<br><br>1. Someone would have to volunteer to maintain the documentation <br>
infrastructure and teach others to use it.<br> <br>2. Submit a complete proposal outlining benefits for the move so that it <br> could be discussed rationally without having to chase down lots of little <br> bits in email, irc, etc.<br>
<br>3. Address the transition process.<br><br>So I went away and did some thinking, and some research and some <br>experimenting, and I decided that I really want this to happen.<br><br>So I am hereby volunteering to manage a Sphinx-based documentation <br>
infrastructure (should there eventually be one) for the Twisted project <br>as well as the transition to said system.<br> <br>I have written up a proposal here:<br><br><a href="http://twistedsphinx.funsize.net/proposal.html" target="_blank">http://twistedsphinx.funsize.net/proposal.html</a><br>
<br>that I think addresses at least the main points of what should need to happen<br>in order to move from Lore to Sphinx. It's not quite finished, but I think <br>it's close enough for people to start discussing it. In particular, there <br>
are a few claims I've made about Lore and it's capabilities that I'm not <br>quite sure of (just search for the question marks).<br><br>I would very much like to get some feedback from the community (especially <br>
the core developers) on this proposal. I'd especially like to hear about:<br><br>- things which are not addressed and should be.<br>- anything that is addressed in the proposal, but you think should be done <br> in a different way.<br>
- Lore's capabilities.<br><br>Please let me know what you think.<br><br>Thanks,<br><br>Kevin Horn<br><br>