Changes between Version 2 and Version 3 of TracDev/ApiDocs

Timestamp:

Nov 18, 2010, 10:56:44 PM (13 years ago)

Author:

Christian Boos

Comment:

added links to generated apirefs and apidoc for trunk

TracDev/ApiDocs

@@ -5 +5 @@
 We propose two ways for taking benefit from this embedded documentation in order to generate API documentation references.
 
- - Full API reference using [http://epydoc.sourceforge.net/ epydoc]
- - Semi-automatic API documentation using [http://sphinx.pocoo.org Sphinx]
+ - ''apiref'' — Full API reference using [http://epydoc.sourceforge.net/ epydoc]
+ - ''apidoc'' — Semi-automatic API documentation using [http://sphinx.pocoo.org Sphinx]
    
 With epydoc, the entirety of the API is covered, but we have less control over the generated output and the documentation is a bit more "dry" and feels, well, ... auto-generated. 
@@ -15 +15 @@
 
 
-== View the documentation — //TODO add links to generated docs//
- - Trac 0.11 (apiref)
- - Trac 0.12 (apiref) 
- - Trac 0.13dev (apiref | apidoc)
+== View the documentation
+ - Trac 0.11 (''apiref'' for [http://www.edgewall.org/docs/tags-trac-0.11.7/epydoc/ 0.11.7])
+ - Trac 0.12 (''apiref'' for [http://www.edgewall.org/docs/tags-trac-0.12/epydoc/ 0.12] | [http://www.edgewall.org/docs/tags-trac-0.12.1/epydoc/ 0.12.1] | [http://www.edgewall.org/docs/branches-0.12-stable/epydoc/ 0.12-stable]) 
+ - Trac 0.13dev ([http://www.edgewall.org/docs/trac-trunk/epydoc/ apiref] | [http://www.edgewall.org/docs/trac-trunk/html/ apidoc HTML] | [http://www.edgewall.org/docs/trac-trunk/pdf/trac_dev.pdf apidoc PDF])
 
-Note that as Trac 0.11 and 0.12 were not really prepared for being processed, the quality of the generated documentation is all but perfect. Not that the one for 0.13dev is, but there we're working on it ;-)
+Note that as Trac 0.11 and 0.12 were not really prepared for being processed, the quality of the generated documentation is all but perfect. It's not that the one for 0.13dev is, but there we're working on it. The 0.12-stable link and the 0.13dev links above should correspond to the latest version //(not yet updated automatically - this is coming next)//.
 
 == Generating the documentation