openstack/mistral
Code Issues Proposed changes
83711c6aea
mistral/doc
History
Dougal Matthews 83711c6aea Use the plain syntax highlighting in the webapi example 
The current example fails highlighting and is skipped because the YAML
lexer rejects it as invalid. This causes a warning to be displayed.

Change-Id: I86c4570fd1f422651a4711417410e7c7b7515637
2017-04-05 10:20:06 +01:00
..
source Use the plain syntax highlighting in the webapi example 2017-04-05 10:20:06 +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