deb-mistral/doc
hparekh 4b80c8f2b9 Documentation for Mistral and Docker.
Purpose of this document is to explain how
to create docker image locally and how to
use it.

TODO: Update information for pre-built mistral
docker image.

Change-Id: I4e7c2e31d716fb4144484a469e30610a5cdd6f9b
Partially-implements: blueprint mistral-docker-image
2015-12-21 01:21:02 +00:00
..
source Documentation for Mistral and Docker. 2015-12-21 01:21:02 +00:00
README.md OpenStack typo 2015-11-17 10:53:48 +08:00

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