openstack/deb-mistral

History

Nikolay Mahotkin 7e1994f619 Mistral documentation: Overview article Partially implements: blueprint mistral-documentation Change-Id: Iaa223357f1ad99e7c2e72b57ff121e15ef80c75f		2015-08-07 13:38:47 +03:00
..
source	Mistral documentation: Overview article	2015-08-07 13:38:47 +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