Re: Contributing FAQ, Questions
| From: | Martin Jansen | Date: | Tue, 17 Oct 2006 19:42:21 +0000 |
| Subject: | Re: Contributing FAQ, Questions | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-44606@lists.php.net to get a copy of this message | ||
On Mon Oct 16, 2006 at 02:3509PM -0400, Peter Beckman wrote:
> The only point I'm having trouble with is the documentation and how it fits
> into my "package" from a directory structure standpoint.
The DocBook documentation is usually not bundled within the source code
of the package, but resides in the peardoc CVS module.
> I've worked with
> DocBook before, but am unsure how the documentation needs to be laid out in
> the directory structure to make sure the system auto-generates the docBook
> HTML gunk on the pear site. I used the suggested converter with success,
> but would like some more information about how exactly I need to lay the
> docs out.
You don't need to use this converter:
The API docs are auto-generated for each release upon upload. For an
example see the right column on http://pear.php.net/package/MDB2/docs/.
The documentation written in DocBook usually provides a less "technical"
view on the package and instead provides verbose usage examples and so
on. This is what lives in the above mentioned peardoc module.
I hope this helps a bit. If not, don't hesitate to ask.
- Martin