Go to file
2014-06-16 21:53:04 +02:00
codeBB [DEV] correction on the links 2013-12-31 21:21:37 +01:00
codeHL [DEV] generated code is now usable 2013-12-27 21:35:30 +01:00
ply [DEV] create the monk basic library 2013-12-22 18:55:48 +01:00
theme [DEV] generated code is now usable 2013-12-27 21:35:30 +01:00
.gitignore [DEV] better display of operator and some other special case 2013-12-23 21:00:43 +01:00
licence_BSD.txt [DEV] better display of operator and some other special case 2013-12-23 21:00:43 +01:00
monk.py [DEV] update the description missing 2013-12-23 22:04:35 +01:00
monkArg.py [DEV] create the monk basic library 2013-12-22 18:55:48 +01:00
monkClass.py [DEV] manage the template function in parsing (not written in doc ...) 2014-06-16 21:53:04 +02:00
monkDebug.py [DEV] create the monk basic library 2013-12-22 18:55:48 +01:00
monkEnum.py [DEV] add support of empty enum 2014-04-24 21:31:22 +02:00
monkHtml.py [DEV] add support of empty enum 2014-04-24 21:31:22 +02:00
monkLibrary.py [DEV] create the monk basic library 2013-12-22 18:55:48 +01:00
monkMethode.py [DEV] manage the template function in parsing (not written in doc ...) 2014-06-16 21:53:04 +02:00
monkModule.py [DEV] add source website 2013-12-28 16:07:12 +01:00
monkNamespace.py [DEV] create the monk basic library 2013-12-22 18:55:48 +01:00
monkNode.py [DEV] add support of empty enum 2014-04-24 21:31:22 +02:00
monkParse.py [DEV] manage the template function in parsing (not written in doc ...) 2014-06-16 21:53:04 +02:00
monkStruct.py [DEV] create the monk basic library 2013-12-22 18:55:48 +01:00
monkTools.py [DEV] create the monk basic library 2013-12-22 18:55:48 +01:00
monkType.py [DEV] 90% of the type display and heritage copy doc 2013-12-26 21:17:20 +01:00
monkUnion.py [DEV] create the monk basic library 2013-12-22 18:55:48 +01:00
monkVariable.py [DEV] better display of operator and some other special case 2013-12-23 21:00:43 +01:00
README.md [DOC] update md file 2013-12-23 21:05:22 +01:00

MONK

Monk is a generic dicumentation maker is a FREE software tool.

This is a tool to generate the binary and application static documentation. It is designed to support the github gh-pages, the it is a no-server-side interaction.

Create a monk doc

Set the monk module maker with the name :

monk_xxxxx.py
xxx : represent the name of the module/application and must be lower case and no special characters

you can see exemple for some type in :

ewol : library
edn : application

Build your documantation:

./monk.py

Copyright (c)

2011, Edouard DUPIN

License (DSB)

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  3. The name of the author may not be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.