History

Nikolay Mahotkin f0d95d99ea Mistral documentation: Initial commit * initial documentation skeleton for further writing. * Added man page to the conf (otherwise we get warning message) * Added ChangeLog to .gitignore * Changed html theme on readthedocs Partially implements blueprint mistral-documentation Change-Id: Iffc6e0e8b97d3599aa8c09b03011586354241abd	2015-08-07 12:06:53 +03:00
..
source	Mistral documentation: Initial commit	2015-08-07 12:06:53 +03:00
README.md	Add documentation - part 3	2014-10-16 20:45:39 -07:00

Nikolay Mahotkin f0d95d99ea Mistral documentation: Initial commit

* initial documentation skeleton for further writing.
 * Added man page to the conf (otherwise we get warning message)
 * Added ChangeLog to .gitignore
 * Changed html theme on readthedocs

Partially implements blueprint mistral-documentation

Change-Id: Iffc6e0e8b97d3599aa8c09b03011586354241abd

2015-08-07 12:06:53 +03:00

source

Mistral documentation: Initial commit

2015-08-07 12:06:53 +03: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