History

Zhao Lei 0f140c7b96 Fix some spelling typo in manual and program output

Fixed following typos.
 infomation -> information
 initilization -> initialization
 intialize -> initialize
 compatability -> compatibility
 compatability -> compatibility
 quering -> querying
 initilization -> initialization
 infomation -> information
 incomming -> incoming

Also fixed some small typo in source comment.

Change-Id: I381aed76094f19f8ef7e821e965fafb0dfe900b2
Signed-off-by: Zhao Lei <zhaolei@cn.fujitsu.com>

2015-09-24 21:10:36 +08:00

source

Fix some spelling typo in manual and program output

2015-09-24 21:10:36 +08:00

README.md

Add documentation - part 3

2014-10-16 20:45:39 -07:00

README.md

Sphinx DOC hints

Migrating from Openstack Wiki

Install pandoc
Copy wiki code into a file, e.g. source.mw
Convert to .rst

pandoc --from=mediawiki --to=rst --output=doc/source/dsl/dsl_v1.rst doc/source/dsl/source.mw
To make code samples fancy:

TODO: figure how to make YAML samples look nicer with code:: directive

Using autodoc with sphinxcontrib.pecanwsme.rest and wsmeext.sphinxext plugins

TODO: why REST URL is not generated with parameters?

Running sphinx-audobuild

auto-loader - rules for convenient development https://pypi.python.org/pypi/sphinx-autobuild/0.2.3. install, and run:

sphinx-autobuild doc/source doc/build