Re: Automated API documentation for new releases
| From: | Jon Parise | Date: | Thu, 15 Apr 2004 20:34:52 +0000 |
| Subject: | Re: Automated API documentation for new releases | ||
| References: | 1 | Groups: | php.pear.doc |
| Request: | Send a blank email to pear-doc+get-3511@lists.php.net to get a copy of this message | ||
On Wed, Apr 14, 2004 at 11:13:03PM +0200, Martin Jansen wrote:
> Adding API documentation (*) to the manual is neither technically nor
> conceptually a good idea. I'll not go into detail about this yet, but
> if people are interested, I can explain the rationale in another mail.
> (Most of the reasons can also be extracted from the list archives.)
>
> So instead I suggest to publish API documentation for each release of a
> package outside of the manual. Concretely this means that the API
> documentation for DB 1.6.2 will be available at
> http://pear.php.net/docs/DB/1.6.2/, while the documentation for
> release
> 2.0.1 will be available at /docs/DB/2.0.1/ etc.
The like this idea.
I think the only area open to debate is whether the documentation
should be located in /docs/$package or in /package/$package/docs.
--
Jon Parise (jon@php.net) :: The PHP Project (http://www.php.net/)