Automatic generation of html doc of services specification
Guillaume Chereau
charlie at openmoko.org
Fri May 23 12:12:43 CEST 2008
Hello everybody !
I need to introduce myself :
My name is Guillaume (or Charlie), I work at openmoko, and I will try to
help for the freemobilephone "standard" specification.
I talked with Mickey, and we agreed that we need some sort of mechanism
to synchronize the spec code on the git master branch and the html
documentation.
I did a small bash script that generates all the xhtml files from the
specs, it takes care of getting the last version from the git server,
and copy all the xhtml files to an output directory.
The idea is to call this script from the post-commit hook in git (by
editing the .git/hook/post-commit file)
Here is the script :
http://pastebin.ca/1026935
it can be called like this :
> generate-html-doc gen_doc_dir doc_dir
where gen_doc_dir would be the directory where we upload and generate
the doc, and doc_dir is the directory where we put the final xhtml
files.
Well, I am not really good at bash scripting, and it is rather small, so
anybody is free to provide a better one (a makefile should work as well)
Once we have this, we can just work on the xml files in the specs
project, and put links on the wiki to the autogenerated xhtml files.
What do you think ?
- Charlie
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: This is a digitally signed message part
URL: <http://lists.linuxtogo.org/pipermail/smartphones-standards/attachments/20080523/4ca4df14/attachment.pgp>
More information about the smartphones-standards
mailing list