History

Dougal Matthews 679fe7bbef Add a Mistral lexer for pygments This allows us to use the following code blocks in the Mistral documentation. .. code-block:: mistral When we do that the code will then be highlighted in a way specific to Mistral, rather than the generic YAML highlighting or none. Change-Id: Ie25725b9f803e247d23f58c4b602be938c75cfbd	2017-04-05 10:17:58 +01:00
..
source	Add a Mistral lexer for pygments	2017-04-05 10:17:58 +01:00
README.md	Fix some trivial SPAG errors in docs	2016-07-14 19:24:08 +01:00

Dougal Matthews 679fe7bbef Add a Mistral lexer for pygments

This allows us to use the following code blocks in the Mistral documentation.

    .. code-block:: mistral

When we do that the code will then be highlighted in a way specific to
Mistral, rather than the generic YAML highlighting or none.

Change-Id: Ie25725b9f803e247d23f58c4b602be938c75cfbd

2017-04-05 10:17:58 +01:00

source

Add a Mistral lexer for pygments

2017-04-05 10:17:58 +01: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