openstack/mistral
Code Issues Proposed changes
5d988122be
mistral/doc
History
Renat Akhmerov b38328513a Deleting all v1 related stuff 
* Old engine
* Endpoints
* Tests
* Fixed launch.cmd script
* Fixed the bug with incorrect RPC objects creation in tests

Change-Id: I8579d0878e8a295823124d3c3452f3c26151d43a
2015-04-07 20:07:24 +06:00
..
source Deleting all v1 related stuff 2015-04-07 20:07:24 +06: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