Ok, i' ll see how to integrate lynx then.
Currently, the target `modname_doc` will produce all forms in the build directory iirc, and then it would copy it to the `src/modules/module_name/docs` directory. (even though I opted to comment the copy command to not pollute the source files.
--
Reply to this email directly or view it on GitHub:
https://github.com/kamailio/kamailio/commit/f24eed8ba01870361d916844a073df7…
You are receiving this because you are subscribed to this thread.
Message ID: <kamailio/kamailio/commit/f24eed8ba01870361d916844a073df71cbc9e609/150282843(a)github.com>
I see `output_dir` in the makefile for the docbooks, not for the code building:
```
doc/docbook/Makefile
39:output_dir ?= .
```
The variant with lynx has to be there, many doc generation scripts running on server rely on it, being also very common on linux distros and we know how the output is generated.
We can experiment more with pandoc in the future.
Are now different make targets (or some defines) to generate the text readme and the html readme? I could notice the `modname_doc` (e.g., `acc_doc`)
--
Reply to this email directly or view it on GitHub:
https://github.com/kamailio/kamailio/commit/f24eed8ba01870361d916844a073df7…
You are receiving this because you are subscribed to this thread.
Message ID: <kamailio/kamailio/commit/f24eed8ba01870361d916844a073df71cbc9e609/150282713(a)github.com>
The `pandoc` was an alternative I found that could achieve what `lynx` did for the text generation, since `lynx` is technically a text web-browser.
Pandoc offers more forms to transform if needed, but of course, we can fall back on' Lynx' if it doesn't fit our needs or it's too slow.
The `outpit_dir` is specific for docs or for the whole build?
I
--
Reply to this email directly or view it on GitHub:
https://github.com/kamailio/kamailio/commit/f24eed8ba01870361d916844a073df7…
You are receiving this because you are subscribed to this thread.
Message ID: <kamailio/kamailio/commit/f24eed8ba01870361d916844a073df71cbc9e609/150282373(a)github.com>
@xkaraman: can the use of `pandoc` be made optional? What is the benefit of using it?
The old makefiles needed only `xsltproc` (and `lynx` for text readme generation) and it seemed enough. Also, the generation of the html readmes for modules on the website is done the same way. Important it would be to support the output directory, like:
```
make output_dir=/tmp/kamailio-docs exclude_modules="" modules-doc
```
The above command generates all html files for modules' readmes and place them in /tmp/kamailio-docs.
--
Reply to this email directly or view it on GitHub:
https://github.com/kamailio/kamailio/commit/f24eed8ba01870361d916844a073df7…
You are receiving this because you are subscribed to this thread.
Message ID: <kamailio/kamailio/commit/f24eed8ba01870361d916844a073df71cbc9e609/150281498(a)github.com>
Yeah, looking into it.
--
Reply to this email directly or view it on GitHub:
https://github.com/kamailio/kamailio/commit/f24eed8ba01870361d916844a073df7…
You are receiving this because you are subscribed to this thread.
Message ID: <kamailio/kamailio/commit/f24eed8ba01870361d916844a073df71cbc9e609/150280974(a)github.com>
@xkaraman this change broke the build
```
cmake --build /home/runner/work/kamailio/kamailio/build -j8
[ 0%] Building C object src/modules/acc/CMakeFiles/acc.dir/acc.c.o
[ 0%] Building C object src/modules/acc/CMakeFiles/acc.dir/acc_cdr.c.o
gmake[2]: *** No rule to make target 'src/modules/xprint_doc', needed by 'src/modules/CMakeFiles/kamailio_docs'. Stop.
[ 0%] Generating cfg.tab.c and cfg.tab.h from cfg.y
gmake[1]: *** [CMakeFiles/Makefile2:3444: src/modules/CMakeFiles/kamailio_docs.dir/all] Error 2
[ 0%] Building C object src/modules/alias_db/CMakeFiles/alias_db.dir/alias_db.c.o
gmake[1]: *** Waiting for unfinished jobs....
```
--
Reply to this email directly or view it on GitHub:
https://github.com/kamailio/kamailio/commit/f24eed8ba01870361d916844a073df7…
You are receiving this because you are subscribed to this thread.
Message ID: <kamailio/kamailio/commit/f24eed8ba01870361d916844a073df71cbc9e609/150280924(a)github.com>