[Twisted-Python] Where are the documentation files?
I am following the instructions on this web page
https://twistedmatrix.com/trac/wiki/ReviewingDocumentation
to prepare a submission for a documentation edit in the pb section of the howto. However, I can't find any of the supposed xhtml files that are supposed to comprise the documentation. For example, the web page mentions
trunk/doc/core/howto/choosing-reactor.xhtml
In my SVN checkout, that file simply does not exist. In fact there aren't any documentation files in the SVN checkout. I would blame this on improper SVN checkout, but here's a copy/paste of the url from whence I got the checkout
svn://svn.twistedmatrix.com/svn/Twisted/trunk
Anyone know what's going on?
Daniel
On 13 February 2014 09:17, Daniel Sank sank.daniel@gmail.com wrote:
I am following the instructions on this web page
https://twistedmatrix.com/trac/wiki/ReviewingDocumentation
to prepare a submission for a documentation edit in the pb section of the howto. However, I can't find any of the supposed xhtml files that are supposed to comprise the documentation. For example, the web page mentions
trunk/doc/core/howto/choosing-reactor.xhtml
In my SVN checkout, that file simply does not exist. In fact there aren't any documentation files in the SVN checkout. I would blame this on improper SVN checkout, but here's a copy/paste of the url from whence I got the checkout
svn://svn.twistedmatrix.com/svn/Twisted/trunk
Anyone know what's going on?
Hi,
There is a process of migrating the documentation to Sphinx. Look in the new /docs/ folder. https://github.com/twisted/twisted/tree/trunk/docs
Good luck Adi
There is a process of migrating the documentation to Sphinx. Look in the new /docs/ folder.
https://github.com/twisted/twisted/tree/trunk/docs
So all of the information on the website regarding how to contribute to documentation is now obsolete and incorrect?
On 13 February 2014 09:40, Daniel Sank sank.daniel@gmail.com wrote:
There is a process of migrating the documentation to Sphinx. Look in the new /docs/ folder.
https://github.com/twisted/twisted/tree/trunk/docs
So all of the information on the website regarding how to contribute to documentation is now obsolete and incorrect?
For now. Feel free to report errors and suggest new text for the site.
On Feb 13, 2014, at 2:53 AM, Daniel Sank sank.daniel@gmail.com wrote:
For now. Feel free to report errors and suggest new text for the site.
Right. What is the appropriate channel to report errors with the website?
Sorry I didn't answer this more promptly.
I think the best answer right now is https://bugs.launchpad.net/twisted-website/+filebug.
We'll try and make this answer better documented or replace it with something better when we can.
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.
If you'd like to write some ReST docs right now and submit a patch, please go ahead!
-glyph
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.
On Feb 27, 2014, at 10:39 AM, Daniel Sank sank.daniel@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
participants (4)
-
Adi Roiban -
Daniel Sank -
Glyph -
Glyph Lefkowitz