Re: reStructuredText

Martin Jansen wrote:

On Wed Jun 11, 2003 at 08:4924PM +0200, Pierre-Alain Joye wrote:

What about the local generation? I got a package, I generate the documentation from the sources, and if I like to get some tutos, it would be nice to get a package and convert it locally to foobar format using a standard tool in the php/pear world.

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.

I have a dream....(which sounds like a good plan)?

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. Please read the phpDocumentor documentation before making comments like that. There is tutorial/example support using files besides your source code. Plus since you generate all the docs in one swoop you can have pointers between the various sections, as well as the ability to grab portions of the code right out your source if you want.

Checkout: http://phpdoc.org/docs/HTMLSmartyConverter/PHP/ All the docs for this were made with phpDocumentor, output formats are shown at: http://phpdoc.org/docs/, right now there is no general docbook converter but there is one optimized for outputtings docs for peardoc2, which could be made to output generic docbook if that is required. -joshua eichorn project admin phpDocumentor