openstack/mistral
Code Issues Proposed changes
b9c7f66345
mistral/doc
History
Shuquan Huang 1049328e87 OpenStack typo 
change capitalization of OpenStack

Change-Id: I1b22f9a9d8797cafd0d61e6e16109d417bcb86d0
2015-11-17 10:53:48 +08:00
..
source Merge "Fixing SSH actions to use names of private keys" 2015-10-23 06:19:08 +00:00
README.md OpenStack typo 2015-11-17 10:53:48 +08: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