deb-mistral/doc/README.md
Miles Gould 2d5ceafecc Fix some trivial SPAG errors in docs
Change-Id: Ie9ea5e2df9eb532a9af55bfad54a9daf941d2bcd
2016-07-14 19:24:08 +01:00

25 lines
722 B
Markdown

# 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](https://pypi.python.org/pypi/sphinx-autobuild/0.2.3) - rules for convenient development https://pypi.python.org/pypi/sphinx-autobuild/0.2.3. install, and run:
sphinx-autobuild doc/source doc/build