Dougal Matthews 9776bbfae4 Use the Mistral syntax highlighting on the dsl v2 page
The examples in this page hit some limitations with the lexer, so it was
updated to handle the unknown tokens and better handle unicode
whitespace characters.

Change-Id: I7883072844ae99bedb8a4c080572da5a31590dd5
2017-04-06 10:20:34 +01:00
..
2016-07-14 19:24:08 +01: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-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