[Twisted-Python] PATCH? /doc/api/index.html
Am I just using the wrong tool for browsing local docs, or is this a reasonable thing to want? I think it would be nice to have a /doc/index.html which points to the website also. 11:02 >cvs diff -u index.html Index: index.html =================================================================== RCS file: /cvs/Twisted/doc/api/index.html,v retrieving revision 1.1 diff -u -r1.1 index.html --- index.html 9 Apr 2002 04:11:17 -0000 1.1 +++ index.html 4 Jan 2003 15:57:16 -0000 @@ -1,6 +1,11 @@ <html> <head><title>The Twisted API Docs</title></head> <body> -This is where the API docs will go in the released tarballs. +<p>This is where the API docs will go in the released tarballs. +</p> + +<p>Latest released API docs are available at: +<a href="http://twistedmatrix.com/documents/TwistedDocs/current/api/">http://twistedmatrix.com/documents/TwistedDocs/current/api/</a> +</p> </body> </html> _________________________________________________________________ Help STOP SPAM: Try the new MSN 8 and get 2 months FREE* http://join.msn.com/?page=features/junkmail
On Sat, Jan 04, 2003 at 04:08:48PM +0000, Lee Harr wrote:
Am I just using the wrong tool for browsing local docs, or is this a reasonable thing to want?
Well, the actual releases come with the API documentation in doc/api. CVS version does not, because the API docs are auto-generated. If you want to generate them yourself from CVS, and you have epydoc installed (http://epydoc.sf.net), the command is "./admin/epyrun -o doc/api" (from your base Twisted/ directory). Otherwise, just either use the website or get the latest release (we have TwistedDocs tarballs as well as a twisted-doc debian package, if you only want to install that).
I think it would be nice to have a /doc/index.html which points to the website also.
I'll apply that. -- Twisted | Christopher Armstrong: International Man of Twistery Radix | Release Manager, Twisted Project ---------+ http://twistedmatrix.com/users/radix.twistd/
On Sat, 4 Jan 2003, Christopher Armstrong <radix@twistedmatrix.com> wrote:
Well, the actual releases come with the API documentation in doc/api. CVS version does not, because the API docs are auto-generated. If you want to generate them yourself from CVS, and you have epydoc installed (http://epydoc.sf.net), the command is "./admin/epyrun -o doc/api" (from your base Twisted/ directory).
I just wanted to add that if you're using Debian sid, you can just "apt-get install python-epydoc" and be happy.
participants (3)
-
Christopher Armstrong -
Lee Harr -
Moshe Zadka