deb-mistral/doc
Kupai József 4e3e19bfb3 Limit the number of finished executions.
A new option was intorduced to execution_expiration_policy to limit
the amount of finished and not expired executions. This can be used
to keep the number of finished executions under a limit, even if a
huge number of executions are created in a short period of time.

Change-Id: I05a604285a6fc510dd224613215dac8d2c31c541
Related-Bug: #1658946
2017-04-10 14:38:04 +02:00
..
source Limit the number of finished executions. 2017-04-10 14:38:04 +02: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