Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Moban.rst: Doc on Moban Usage in Coala #601

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Prev Previous commit
Next Next commit
update basic description of the moban page
  • Loading branch information
Lancasterwu committed Mar 9, 2020
commit b9ce174053bb4d63651e8e07f414fcf6854579df
34 changes: 34 additions & 0 deletions Users/Moban.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
What is Moban?
====================

Description
-----------------

Moban is an open source general purpose static text generator , which can use
other python template engine: mako, handlebars, velocity, haml, slim and
tornado, can read other data format: json and yaml, and can access both template
file and configuration file in any location: zip, git, pypi package, s3, etc.
It is used in coala project to keep documentation consistent across the
documentations of individual libraries in the same organisation. You can find
more documentation on `MobanDocumentation https://moban.readthedocs.io/en/latest/`__

Install ``moban``:

::

$ pip install moban

CLI arguments:

::

moban [-h] [-c CONFIGURATION] [-t TEMPLATE] [-o OUTPUT] [-td [TEMPLATE_DIR [TEMPLATE_DIR ...]]]
[-cd CONFIGURATION_DIR] [-m MOBANFILE] [-g GROUP] [--template-type TEMPLATE_TYPE]
[-d DEFINE [DEFINE ...]] [-e EXTENSION [EXTENSION ...]] [-f][--exit-code]
[-V] [-v][template]

Sample usage:

::

mohan -c [input file(JSON, YAML)] -t [template file] -o [outputfile]