Dougal Matthews 909241c642 Update Expiration Policy Documentation
This change re-writes the section covering the expiration policy to explain it
in more detail and also include the required evaluation_interval setting which
was previously undocumented.

Change-Id: Ib7f4e8ccf4c15cc6e22472b28004d0a9ad34497f
2016-07-01 15:06:49 +01:00
..
2015-11-17 10:53:48 +08: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-audobuild

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