Re: reStructuredText (was: RE: [PEAR-DEV] Net_SMTP user's guide)

On Wed, 11 Jun 2003 22:32:55 +0200 Martin Jansen <mj@php.net> wrote: > I don't understand what you mean. There will be no need to do anything > locally: Every package that has documentation will ship this > documentation in the archive. You are right, or maybe not. Imho, I cannot imagine to ship others documentation than the API docs with the packages. Even the API docs should be generated once installer using the desired format, set in the user preferences. > Using phpDocumentor for *all* documentation related topics still > implies for me that the documentation (usage examples, tutorials) will > be stored within the source code. This definitively isn't optimal. You may look again at phpDocumentor. You will see there is something about general documentations and not inline docs. Using only it allows us to make link from the inline docs to outline documentations/tutorials. A brief history, first we got an extension to manage inline docs. Then Ulf made a great job with phpdoc. This package fallen orphan during months. Then Greg came in with his really good phpDocumentor, enhancing it days after days, keeping it as the highest level possible for 2 guys work. phpDocu got near all the core to do everything related to documentations, using only php. We are discussing about a lite version. This lite version should provide the root kits to generate standart PEAR documentations (from inline docs and/or tutorials files). So, indeed we can use again another external non php tools, this time in python *sigh*. However why not give a kick to phpdocument and help Greg and Joshua to integrate it in a good manner in PEAR? pierre