openstack/deb-mistral
Code Issues Proposed changes
b5140060a0
deb-mistral/doc
History
Dmitri Zimine b4d9c57e36 Docs fix - small structure fix 
Removed redundant root level.

Change-Id: Iac3e01974a2e1c2b64e31109b748e61ec8306408
2014-10-16 20:45:39 -07:00
..
source Docs fix - small structure fix 2014-10-16 20:45:39 -07: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