openstack/deb-mistral
Code Issues Proposed changes
34232f0c35
deb-mistral/doc
History
hardik 34232f0c35 Added 'pip install -r requirements.txt' instruction 
'python setup.py install' will not install requirements.
We have to install it manually.

Please see comment #6 here:
https://bugs.launchpad.net/pbr/+bug/1341341

Change-Id: Ie45e0315f55262b98d6f5ce3a0244691a54192bd
2016-07-22 11:07:40 +05:30
..
source Added 'pip install -r requirements.txt' instruction 2016-07-22 11:07:40 +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