openstack/mistral

Dmitri Zimine b8390eb84d Add documentation - part 3

Document REST v2 with autodocs

Change-Id: Ib43d2237ebb0f8ef9f8d18e70182d7cc5f2f0828

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

727 B

Raw Blame History

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