openstack/deb-mistral
Code Issues Proposed changes
f7e04b3ef9
deb-mistral/doc
History
Sharat Sharma 6973f75d60 [doc] Changed the output fields in quickstart guide 
As there are few more fields added to the client and the document
was not updated, this commit updates the output of each command
accordingly.

Change-Id: Ie5c87b269a58c79bf37c7a93b79d6068352b79bd
Closes-Bug: #1670329
2017-03-06 17:48:07 +05:30
..
source [doc] Changed the output fields in quickstart guide 2017-03-06 17:48:07 +05:30
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