History

Sharat Sharma 912056dd8b Few changes related to the doc blueprint 1. * We need to either remove "Roadmap" from the index page completely and add it to some special article devoted to development or at least to move it to the end of the list (http://docs.openstack.org/developer/mistral/) - Done 2. * Article "Mistral Client / CLI guide" is messed up. Two problems: 1) "Mistral Client" in this name is about installation which doesn't explicitly tell this (should be "Mistral Client Installation Guide") 2) "CLI guide" is not about installation and should exist as a separate article. (http://docs.openstack.org/developer/mistral/) - Done Change-Id: I9f2e7e24ce71e1c022b2918f455d805bab4740fe Partial-Implements: blueprint mistral-doc	2016-11-11 11:36:23 +00:00
..
source	Few changes related to the doc blueprint	2016-11-11 11:36:23 +00:00
README.md	Fix some trivial SPAG errors in docs	2016-07-14 19:24:08 +01:00

Sharat Sharma 912056dd8b Few changes related to the doc blueprint

1. * We need to either remove "Roadmap" from the index page completely
   and add it to some special article devoted to development or at least
   to move it to the end of the list
   (http://docs.openstack.org/developer/mistral/) - Done

2. * Article "Mistral Client / CLI guide" is messed up. Two problems:
   1) "Mistral Client" in this name is about installation which doesn't
   explicitly tell this (should be "Mistral Client Installation Guide")
   2) "CLI guide" is not about installation and should exist as a
   separate article. (http://docs.openstack.org/developer/mistral/) - Done

Change-Id: I9f2e7e24ce71e1c022b2918f455d805bab4740fe
Partial-Implements: blueprint mistral-doc

2016-11-11 11:36:23 +00:00

source

Few changes related to the doc blueprint

2016-11-11 11:36:23 +00: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