History

Dougal Matthews 3ad596ce57 Rework the CLI Guide The previous version contained badly formatted reStructuredText which caused rendering issues. It also contained the help output for commands, but it wasn't updated or complete. This new document tells used how to view and use the CLI so they can get the help output easily themselves. This removes the rendering issues and the need to keep this page updated. Change-Id: Ic97185035ef22a9d6d291b9f396488139e8a7e2d	2017-04-06 15:25:38 +01:00
..
source	Rework the CLI Guide	2017-04-06 15:25:38 +01:00
README.md	Fix some trivial SPAG errors in docs	2016-07-14 19:24:08 +01:00

Dougal Matthews 3ad596ce57 Rework the CLI Guide

The previous version contained badly formatted reStructuredText which
caused rendering issues. It also contained the help output for commands,
but it wasn't updated or complete.

This new document tells used how to view and use the CLI so they can get
the help output easily themselves. This removes the rendering issues and
the need to keep this page updated.

Change-Id: Ic97185035ef22a9d6d291b9f396488139e8a7e2d

2017-04-06 15:25:38 +01:00

source

Rework the CLI Guide

2017-04-06 15:25:38 +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