History

Nikolay Mahotkin 7494eefa82 Mistral documentation: CLI operations

Note: Created a script for getting useful help info
for each mistral command.

Implements blueprint: mistral-docs-cli

Change-Id: Ie04b4df523bad165f3a19e1879c856b07031e526

2015-09-17 13:43:48 +03:00

source

Mistral documentation: CLI operations

2015-09-17 13:43:48 +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