openstack/mistral
Code Issues Proposed changes
554e14e435
mistral/doc
History
Renat Akhmerov cf0cc484bc Add asynchronous actions doc 
Change-Id: Idef3fed51099875d2200b1a29af152be23a0215f
Implements: blueprint mistral-async-actions-doc
2016-03-02 17:08:56 +06:00
..
source Add asynchronous actions doc 2016-03-02 17:08:56 +06:00
README.md OpenStack typo 2015-11-17 10:53:48 +08: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-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