Jump to: navigation, search

Mihini/Mihini Generate Documentation

< Mihini
Revision as of 10:58, 17 April 2013 by Lbarthelemy.sierrawireless.com (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

1. Get the source


Mihini Git repository


2. Install prerequisites


Install pandoc and doxygen on your dev machine: usually it is as simple as using the package manager of your operating system. Example: {code} sudo apt-get install pandoc doxygen {code}

More details on: http://www.stack.nl/~dimitri/doxygen/download.html http://johnmacfarlane.net/pandoc/installing.html

3. Build the documentation


Building the documentation is linked to Mihini build system, that is explained here:

{code} build.sh cd build.default make mdoc doxygen_gen {code}

There are 3 targets: - mdoc - luaExecEnv - doxygen_gen


4. Doc Artifacts


Everything is generated as html in:

{code} build.default/doc/ build.default/doc/md build.default/doc/ldoc build.default/doc/doxygen {code}