On Tuesday 21 April 2009, Jan Janak wrote:
perhaps it was not a good idea to try to merge the modules after all if also documentation style is different in k and s, because we need to have two doc subdirs in all of them (one for k and another for s).
I don't understand this. In both cases it is xml based docbook. The structure of a docbook document is given. The fact that there are more files with boilerplate in modules coming from ser does not make it that much different.
fine if we can have READMEs autogenerated no matter which docbook files doc subdir contains.
Of course, that will be possible. I don't know what were the steps to generate READMEs in kamailio, in ser modules we added a Makefile in each documentation directory and you can just type make txt to generate the README or make html to generat HTML based documentation.
Hi Jan,
module documentation in kamailio can be generated with (e.g. in old trunk):
- make modules-readme
This will generate the READMEs in all module directories, from the source in the respective 'doc' sub directory, for all modules that are not in the exclude_modules list. You can specify a certain module with "make modules-readme modules=$module_name" as usual.
- modules-docbook-html - modules-docbook-man - modules-docbook-pdf
will generates the respective output format in the module directory as well.
We can either add Makefiles to modules in modules_k or import the kamailio system. But in any case we will be using the same tools and templates to generate READMEs.
Sounds good, i prefer to not have two different documentation formats for modules in our tree.
Cheers,
Henning