History

ZhiQiang Fan a260cc7e47 fix doc dsl v2 * the workbook namespacing image name is wrong which cause image is missing * the example of task doesn't indent correctly which cause code block broken * title level is not consistent which cause some titles are missing, recommended: http://sphinx-doc.org/rest.html#sections Change-Id: I2a3378537b86363d34abafb14580d85914ce304e	2015-01-29 11:34:55 +08:00
..
source	fix doc dsl v2	2015-01-29 11:34:55 +08:00
README.md	Add documentation - part 3	2014-10-16 20:45:39 -07:00

ZhiQiang Fan a260cc7e47 fix doc dsl v2

* the workbook namespacing image name is wrong which cause image is
  missing
* the example of task doesn't indent correctly which cause code block
  broken
* title level is not consistent which cause some titles are missing,
  recommended: http://sphinx-doc.org/rest.html#sections

Change-Id: I2a3378537b86363d34abafb14580d85914ce304e

2015-01-29 11:34:55 +08:00

source

fix doc dsl v2

2015-01-29 11:34:55 +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