[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-devel
Subject:    Re: 'make doc' (was:Re: Documentation standard ??)
From:       Leon Widdershoven <l.widdershoven () fz-juelich ! de>
Date:       1999-07-07 16:20:19
[Download RAW message or body]

Sirtaj Singh Kang wrote:
> 
> On Wed, 7 Jul 1999, Michael Koch wrote:
> [snip]
> > > Have a look into current Linux distros, most if not all do not ship with KDE
> > > library docu...know why? Packagers are lazy ;) they don't want to download kdoc
> > > (kdesdk) and generate the docu by hand. Why not simply move kdoc into kdesupprt
> > > (its just a few KB) and add a 'docu' target to kdelibs/Makefile.am
> > > (Stephan?:) that automagically generates the docu?
> >
> > Arrgh.
> >
> > Where should the docu be saved ? How should it be available via apache (or
> > other www-server) ?
> >
> > The user has to decide this questions.
> 
> If someone came up with good solutions to these problems, I'd have "make
> doc" in kdelibs in a flash. I haven't come up with one in over 2 years. :)
> Then again, my brain is addled.
> 

Why not walk in the footsteps of Qt and have something like
(kfm-optimized:)

kdelibs/
	kdecore
	kdeui
	...
->	html/
		MAKE_DOC_FIRST
		README
		index.html
		kdecore
		kdeui
		...


And README states that you should execute (cd .. && make doc) or
something
like that. Then this nice dir. structure will be filled with docs.

I do think API docs should not be generated by default, but maybe make 
could mention it, or configure: configure --with-api-docs

Leon
 

-- 
In a world without walls and fences,  l.widdershoven@fz-juelich.de
who needs Windows and Gates?          Institute of Plasma physics (IPP)
                                      Forschungszentrum Juelich GmbH

[prev in list] [next in list] [prev in thread] [next in thread]