Re: looking for volunteers phpDocumentor, new converter reST
| From: | Martin Jansen | Date: | Fri, 13 Jun 2003 12:54:07 +0000 |
| Subject: | Re: looking for volunteers phpDocumentor, new converter reST | ||
| References: | 1 | Groups: | php.pear.dev php.pear.doc |
| Request: | Send a blank email to pear-dev+get-17393@lists.php.net to get a copy of this message | ||
On Fri Jun 13, 2003 at 11:3816AM +0200, Pierre-Alain Joye wrote:
> Jon came in with a proposal to write endusers documentation. It's based
> on the reST format (1). The conversion to docbook and the parsing tools
> uses tools based on python, docutils (2).
>
> The format looks simple and easy to learn and should fit some developers
> needs that will not work with docbook or uses advanced tools to write
> docs and then convert them to docbook/peardoc2.
>
> I do not like the idea to use many tools for such widely used tools. We
> should have one standart tools for such tasks.
>
> A good compromise should be to implement a reST parser in
> phpDocumentor.
Why do we need to use phpDocumentor? Why can't we use a reST <-> Docbook
converter and thus have the reST documentation available in peardoc2
immediately?
> - The peardoc team can convert the original document to peardoc2 to edit
> it using the usual tools, as well as test the generated docs
> - do not depend on another langage, php rulez ;)
As already stated before, it should be fairly easy to provide a system
on pear.php.net.
--
- Martin Martin Jansen
http://martinjansen.com/