mopowg is an easy to install, cross-platform doc generator which is based on docutils.
mopowg could generate full documents with figures, styles, and syntax highlighting blocks.
Runner is the build in server which host the documents;
Plugins:
Interpreter is the crunchy interpreter that allow you to execute the demo codes on doc;
Commenter is append fields for comment
Diagram:
___________
| |
| files |
| |
|_________|
|
----------------
|doc processing|
----------------
|
Runner - plugins
|
|- Interpreter
|
|_ Commenter
Diagram:
___________
| |
| files |--hg repository
| |
|_________|
|
----------------
|doc processing|
----------------
|
----------------
| doc hosting |
----------------
|
wikier
[1]: not implemented yet
This is the MIT license:
http://www.opensource.org/licenses/mit-license.php
Copyright (c) 2007 Fred Lin and contributors. Mopowg is a trademark of Fred Lin.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
proc_dir(file_list,
dirName,
files)
The callback function of os.path.walk() to get the list of scanned
files. |
source code
|
|
|
|
|
|
|
saver(path,
content,
output,
style='
' ,
nostyle=False,
ext=' .html ' )
save content to file |
source code
|
|
|
templater(input,
content,
template)
generate with genshi template |
source code
|
|
|
processor(input,
content,
output,
template,
style,
preview=False)
process the content |
source code
|
|
|
pygments_directive(name,
arguments,
options,
content,
lineno,
content_offset,
block_text,
state,
state_machine)
register the docutils highlight function |
source code
|
|
|
convertor(path,
*arg,
**kw)
Convert file to target format, include syntax highlight function |
source code
|
|
|
generator(input,
filter=[ ' .rst ' , ' .txt ' ] ,
output=None,
rich=True,
wikiword=True,
template=' \n<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional// ... ,
style=' body {\n margin: 0;\n padding: 0;\n font-family: Ver ... ,
preview=False)
generate docs |
source code
|
|
|
|