Re: Status report: Automated API documentation

From: Date: Sun, 02 May 2004 16:32:41 +0000
Subject: Re: Status report: Automated API documentation
References: 1  Groups: php.pear.dev php.pear.doc 
Request: Send a blank email to pear-dev+get-28704@lists.php.net to get a copy of this message
It looks really cool. Does it have support for tutorials in the docs? I have tutorials for Structures_Graph in DocBook format: http://pear.sergiocarvalho.com/docs/Structures_Graph/ but these don't show up in: http://pear.php.net/reference/Structures_Graph-1.0/ Note: they couldn't possibly appear, since the tutorials are in the source repository, but aren't part of the installable .tgz. I'm just wondering how do I package Structures_Graph so the tutorials get picked up by the API doc generator. Congrats on the great work. Cheers, -- Sérgio Carvalho AIM: SergioSGC / ICQ: 67512780 Martin Jansen wrote: > As you might have noticed from my commits yesterday, the infrastructure > for automatically generating API documentation for new releases is in > place now. > > In the next days, the API documentation will also be linked on the > package homepages (http://pear.php.net/package/<package>/). For now you > can have a look at the already existing documentation at > > http://pear.php.net/reference/ > > (Long list, so it may take some time to load. Additionally /reference/ > is likely not the final URL.) > > The fonts are a bit too small at the moment, but this will be changed > soon. > > I'd be happy if the folks, who will attend to the developers meeting > tomorrow, take the disposability of the API documentation into account > when discussing about future directions of the PEAR documentation: The > automatically generated documentation will of course not replace > documentation that is targeted at end-users, but I believe that it is a > good start. > > If you would like to write a followup to this mail, please make sure > that the mail goes to pear-doc and _not_ to pear-dev. >

Attachment: [application/pgp-signature] OpenPGP digital signature signature.asc
« previous php.pear.dev (#28704) next »