Clean up heat-translator documentation

Several RST formatting errors, added some more content too.

Change-Id: I44a557398e668152c38ddad07c01ea6cd38b65ea
This commit is contained in:
Steve Martinelli 2014-08-28 11:41:15 -04:00
parent 2f9f244b29
commit 175af0fe58
4 changed files with 15 additions and 14 deletions

View File

@ -1,13 +1,10 @@
===============================
===============
heat-translator
===============================
===============
Tool to translate non-heat templates to Heat Orchestration Template.
* Free software: Apache license
* Documentation: http://docs.openstack.org/developer/heat-translator
Features
--------
* TODO
* Documentation: http://heat-translator.readthedocs.org/
* Bugs: https://launchpad.net/heat-translator
* Source: https://github.com/stackforge/heat-translator/

View File

@ -4,14 +4,19 @@
contain the root `toctree` directive.
Welcome to heat-translator's documentation!
========================================================
===========================================
The heat-translator tool is aimed to translate non-heat templates to OpenStack
Heat Orchestration Template (HOT). Initially the tool is aimed to translate
OASIS Topology and Orchestration Specification for Cloud Applications (TOSCA)
to HOT. However, the tool can be easily extended to support any non-heat
template format to produce HOT.
Contents:
.. toctree::
:maxdepth: 2
readme
installation
usage
contributing

View File

@ -1 +0,0 @@
.. include:: ../README.rst

View File

@ -1,7 +1,7 @@
========
=====
Usage
========
=====
To use heat-translator in a project::
import heat-translator
import heat-translator