History

Sharat Sharma 1e20b04c87 Stop using abbreviation DSL in document Sometimes people get confused when DSL is used. So, to overcome it Mistral Workflow Language is used instead of DSL throughout the documentation. Change-Id: Ic7516b4f45854fd9960cef3e529dcb507439f8e6 Partially-implements: blueprint add-documentation	2017-06-05 17:03:43 +05:30
..
source	Stop using abbreviation DSL in document	2017-06-05 17:03:43 +05:30
README.md	Fix some trivial SPAG errors in docs	2016-07-14 19:24:08 +01:00

Sharat Sharma 1e20b04c87 Stop using abbreviation DSL in document

Sometimes people get confused when DSL is used. So, to overcome it
Mistral Workflow Language is used instead of DSL throughout the
documentation.

Change-Id: Ic7516b4f45854fd9960cef3e529dcb507439f8e6
Partially-implements: blueprint add-documentation

2017-06-05 17:03:43 +05:30

source

Stop using abbreviation DSL in document

2017-06-05 17:03:43 +05:30

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