Re: Publishing API documentation for each release

On Tue Mar 09, 2004 at 12:4553AM +0100, Stefan Neufeind wrote: > On 8 Mar 2004 at 18:30, Daniel Convissor wrote: > > > On Tue, Mar 09, 2004 at 12:13:32AM +0100, Stefan Neufeind wrote: > > > > > But using HTML directly is imho not a good solution, since HTML is > > > not well structured at all. I'm against using plain HTML for the > > > whole doc (at the moment) ... > > > > For the main documentation, I agree. For the docs generated directly > > from package source code using phpDocumentor, I agree with Martin, > > HTML only output is just fine. > > So you want to split off all package-docs from the manual? That is not entirely correct: There will still be documentation for packages in the PEAR manual, but it will nto contain API documentation anymore: The manual will provide examples, usage tutorials etc., but the documentation that can be generated with phpDocumentor will be provided externally. > I don't think this is a good idea either. http://marc.theaimsgroup.com/?l=pear-doc&m=107563477711293&w=2 is the first mail in the thread and it lists my reasons for splitting of the API documentation. All up most people here agreed to my plan back when I first suggested it. > Were do you want to generate that output from? Directly from CVS, > nightly, using phpDocumentor on the server? For each new release that is rolled, the documentation will be generated directly after the release upload. For all existing releases, I'm going to generated them once and upload them manually to pear.php.net. -- - Martin Martin Jansen http://martinjansen.com/