2013-12-23 21:00:43 +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 :
|
2013-12-23 21:05:22 +01:00
|
|
|
|
2013-12-23 21:00:43 +01:00
|
|
|
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 :
|
2013-12-23 21:05:22 +01:00
|
|
|
|
2013-12-23 21:00:43 +01:00
|
|
|
ewol : library
|
|
|
|
|
edn : application
|
|
|
|
|
|
|
|
|
|
Build your documantation:
|
2013-12-23 21:05:22 +01:00
|
|
|
|
2013-12-23 21:00:43 +01:00
|
|
|
./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.
|
