openstack/mistral
Code Issues Proposed changes
faaa8b5d78
mistral/doc
History
Jenkins 4813542ab6 Merge "Remove the deprecated configuration options"
2017-06-13 11:04:13 +00:00
..
source Merge "Remove the deprecated configuration options" 2017-06-13 11:04:13 +00:00
README.md Fix some trivial SPAG errors in docs 2016-07-14 19:24:08 +01: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-autobuild

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