History

Nina Goradia fdb24bd697 module docs are not being generated The pbr section in setup.cfg is not defined, so the module docs are not being generated. This causes the 404 when clicking on the ‘Module Index’ link under the 'Indices and Tables’ section in [0]. [0] http://docs.openstack.org/developer/mistral/ Change-Id: I337e9f6e78257a3e8e9222779dfcd600ba6cebd8 Closes-bug: #1558574	2016-03-21 17:27:14 -05:00
..
source	module docs are not being generated	2016-03-21 17:27:14 -05:00
README.md	OpenStack typo	2015-11-17 10:53:48 +08:00

Nina Goradia fdb24bd697 module docs are not being generated

The pbr section in setup.cfg is not defined, so the module docs are not being
generated. This causes the 404 when clicking on the ‘Module Index’ link under
the 'Indices and Tables’ section in [0].

[0] http://docs.openstack.org/developer/mistral/

Change-Id: I337e9f6e78257a3e8e9222779dfcd600ba6cebd8
Closes-bug: #1558574

2016-03-21 17:27:14 -05:00

source

module docs are not being generated

2016-03-21 17:27:14 -05:00

README.md

OpenStack typo

2015-11-17 10:53:48 +08: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