openstack/mistral

History

Nikolay Mahotkin 25a1242c32 Fixing indentation in 'create action' tutorial Partially implements blueprint mistral-documentation Change-Id: I50fa230684b4ef64f7f6ae81d342d670eb5bf695		2015-09-14 16:33:54 +03:00
..
source	Fixing indentation in 'create action' tutorial	2015-09-14 16:33:54 +03: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