Re: Online doc generator

From: Date: Mon, 12 Apr 2004 08:51:10 +0000
Subject: Re: Online doc generator
References: 1 2  Groups: php.pear.dev 
Request: Send a blank email to pear-dev+get-27442@lists.php.net to get a copy of this message
Bertrand Mansion wrote:
That's for sure, it looks like people using docbook think they are clever guys. Actually, docbook is not only XML as you tend to think it is. It is also difficult to install because not very compatible, it takes a lot of disk space, it doesn't install in standard places and the version used by PEARDOC is custom and incomplete, so it is difficult to find. I spent 2 days trying to get this to work, I won't waste more time on it.
Well Bertrand, that sounds like a lame excuse to me. AFAIR installing [open]jade, sgml-tools and docbook-dsssl on debian took me about 30 seconds - not that I'd have done anything more special than apt-get install.
Furthermore, if you don't have the super cool converters used by peardoc and openjade or whatever, you will have to wait up to one week to see the results of the changes you have made to the doc in CVS, and maybe realized you made a mistake. Correct the typo, then wait another week before it is published. You have to be kidding.
There are quite some places where you can view peardoc builds on the fly or generated regularily, despite the fact that you can make html yourself when you've finished the docs, so I guess you are kidding :)
The fact that almost no documentation is being written at the moment is just an evidence so stop lying to yourself and open your eyes.
It's just a fact for us being lazy developers´, IMHO :)
No, AFAIK it takes a week (what a joke). And it would be silly to think we won't reach 1500 pages one day, especially if PEAR gets more open and people actually write documentation (which, I admit, is not the case today). And if the system is so efficient, why do you have to rebuild the whole doc to reflect just one typo fix. We already have CVS, so why not query it to get the last revision and just merge with the previous one.
These are valid points, though.
Actually, Subversion would be better for this job, if only we had a Subversion extension in PHP. All it could take is Subversion + reST + PHPDocumentor + reST->PEAR.
Regards, Michael

« previous php.pear.dev (#27442) next »