looking for volunteers phpDocumentor, new converter reST
| From: | Pierre-Alain Joye | Date: | Fri, 13 Jun 2003 09:38:16 +0000 |
| Subject: | looking for volunteers phpDocumentor, new converter reST | ||
| Groups: | php.pear.dev php.pear.doc | ||
| Request: | Send a blank email to pear-dev+get-17386@lists.php.net to get a copy of this message | ||
Hello,
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.
That will solve every issues:
- Allow the developers to work with their preferred editing tools (txt
;)
- 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 ;)
- do not depend on external tools to work with docs and even better
- keeping one single tool (which should be part of the "core"/PFC
elements), no more confusions
All related documentations about phpDocumentor converters and parsers
can be found in the phpdocu site (3).
Any comments? volunteers?
pierre
(1) http://docutils.sourceforge.net/rst.html
(2) http://docutils.sf.net
(3) http://www.phpdoc.org