openstack/mistral
Code Issues Proposed changes
7c75d37d8f
mistral/doc
History
Dougal Matthews 1fe7b49301 Add a note to the documentation about std.fail 
Change-Id: Id6dbc1bd47d2f4c8d01dd99d6fbe66de3396026a
2016-08-26 10:29:33 +01:00
..
source Add a note to the documentation about std.fail 2016-08-26 10:29:33 +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