openstack/mistral
Code Issues Proposed changes
d597dab65c
mistral/doc
History
tengqm 83e2431b35 Fix configuration generator 
The current behavior of 'genconfig' is writing file
'mistral.conf.sample' directly to the '/etc/mistral' directory. This has
two problems: the /etc/mistral directory may and may not exist; we are
supposed to write a usable configuration file into the '/etc/mistral'
directory instead of a sample file.

This patch redirects the output path to the local 'etc' subdirectory.
Developers/users can then tune and install the configuration file based
on the sample.

Change-Id: I0c75ab9ffc9960ba12ce6f5d725c0c7bb78ef238
2016-12-19 07:12:41 -05:00
..
source Fix configuration generator 2016-12-19 07:12:41 -05: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