[Twisted-Python] Where are the documentation files?

Glyph Lefkowitz glyph at twistedmatrix.com
Tue Mar 4 15:50:29 MST 2014


On Feb 27, 2014, at 10:39 AM, Daniel Sank <sank.daniel at gmail.com> wrote:

>>> Also, do you have any idea when the new documentation system will up and
>>> ready for contributions?
>>> 
>> It's up and running; there should be a lot less need for documentation (although
>> as you pointed out the current docs are wrong) because sphinx is better
>> understood generally in the wider Python community.
> 
> Cool. I'm enough of a n00b that sphinx versus whatever else is all Greek for me.
> 
>> If you'd like to write some ReST docs right now and submit a patch, please go ahead!
> 
> Working on it.

Let me just stress that you should work on getting the english part of the documentation right, and someone else will happily help you with the formatting.  If you just can't figure out the documentation toolchain, write it in plain text.  Don't get stuck on ReST or Sphinx nonsense :-).

-glyph

-------------- next part --------------
A non-text attachment was scrubbed...
Name: smime.p7s
Type: application/pkcs7-signature
Size: 4124 bytes
Desc: not available
URL: <http://twistedmatrix.com/pipermail/twisted-python/attachments/20140304/85998dae/attachment.bin>


More information about the Twisted-Python mailing list