openstack
/
mistral
Code Issues Proposed changes
mistral/doc
History
Renat Akhmerov d8d2136f0a Fixing "Task result / Data Flow" section of "Main Features" in docs 
Change-Id: I63881f13f0c517a9b50f90d387b6cfcaa7f03d52
Partial-Bug: #1504582
(cherry picked from commit 66a4f85214)
 		2015-10-16 03:38:52 +00:00
..
source Fixing "Task result / Data Flow" section of "Main Features" in docs 2015-10-16 03:38:52 +00:00
README.md Add documentation - part 3 2014-10-16 20:45:39 -07: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