How to use gtk-doc for library.gnome.org (libgo)



Hi,

I am working on library.gnome.org (libgo), location that will present user
and developer docs for Gnome platform, including API references for
current and past versions of libraries that are part of it and built with
gtk-doc. You can find more about libgo in [1].

My main problem is that docs need to be built on web server and I am
unable to use standard make magic to built API references (as deps does
not exist on server). I tried to setup sandbox environment where I can get
source and  tmpl directory, main SGML file, referenced XML files... and
run gtkdoc-scan, gtkdoc-mkdb and gtkdoc-mkhtml
but I ran into problems [2].

Is this possible to do for all modules? It seems to me there are too many
corner cases to think about. Maybe there is some other way I can fetch
"something" from CVS and build DocBook file directly on the web server?


Or request to have generated DocBook file available in CVS for every
gtk-doc document is possible? Then it will be much easier to have
translated API references (using xml2po from gnome-doc-utils) and I will
be able to present API refs as part of libgo like all other user docs.

To quote Shaun McCance on this: "This has been a problem for just about
everybody who's tried to do automated documentation grabbing from CVS.
It's also going to present a problem for documentation translation and
other stuff. I really think generated documentation files should just go
in CVS. It makes life easier."


Goran Rakic

--
[1] http://live.gnome.org/GnomeWeb/Library
[2] For gnome-vfs module, executed commands are in COMMANDS.txt, and
errors are attached as ERRORS-MKDB.txt and ERRORS-MKHTML.txt





[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]