mistral/doc
Nikolay Mahotkin 9581f2e33a Fixing SSH actions to use names of private keys
* SSH action uses private key names instead of
   private keys themself. All private keys now
   should be in <user-home>/.ssh/, e.g. searching
   of key 'my_key.pem' will be at <user-home>/.ssh/my_key.pem
 * Fixed functional tests
 * Remove sudo while running tests

Closes-Bug: #1507600

Change-Id: I503d78ff541183ce850476229842fa6f20061a00
(cherry picked from commit 56f2d5f4b5)
2015-11-25 14:40:22 +00:00
..
source Fixing SSH actions to use names of private keys 2015-11-25 14:40:22 +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