From: Steve Baker <sbaker@redhat.com>
Date: Thu, 25 Jul 2013 21:04:12 +0000 (+1200)
Subject: Auto-document all resource types.
X-Git-Tag: 2014.1~316^2
X-Git-Url: https://review.fuel-infra.org/gitweb?a=commitdiff_plain;h=4af4c719a87731c61757adee8a28e83f8aee95f8;p=openstack-build%2Fheat-build.git

Auto-document all resource types.

There are separate pages for OpenStack, AWS and Rackspace resources.

Currently the following sources are used for resource type documentation:
- the docstring for the resource class
- properties_schema
- attributes_schema

Change-Id: I901d227e8bc2a7209f216b57653da77a4f500e47
---

diff --git a/doc/source/template_guide/cfn.rst b/doc/source/template_guide/cfn.rst
new file mode 100644
index 00000000..c7f3a213
--- /dev/null
+++ b/doc/source/template_guide/cfn.rst
@@ -0,0 +1,16 @@
+..
+      Licensed under the Apache License, Version 2.0 (the "License"); you may
+      not use this file except in compliance with the License. You may obtain
+      a copy of the License at
+
+          http://www.apache.org/licenses/LICENSE-2.0
+
+      Unless required by applicable law or agreed to in writing, software
+      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+      License for the specific language governing permissions and limitations
+      under the License.
+
+CloudFormation Compatible Resource Types
+----------------------------------------
+.. resourcepages:: AWS::
\ No newline at end of file
diff --git a/doc/source/template_guide/index.rst b/doc/source/template_guide/index.rst
index 3c5ed7eb..baf1b53e 100644
--- a/doc/source/template_guide/index.rst
+++ b/doc/source/template_guide/index.rst
@@ -17,4 +17,7 @@ Template Guide
 .. toctree::
    :maxdepth: 2
 
-   functions
\ No newline at end of file
+   functions
+   openstack
+   cfn
+   rackspace
\ No newline at end of file
diff --git a/doc/source/template_guide/openstack.rst b/doc/source/template_guide/openstack.rst
new file mode 100644
index 00000000..f342a6e0
--- /dev/null
+++ b/doc/source/template_guide/openstack.rst
@@ -0,0 +1,17 @@
+..
+      Licensed under the Apache License, Version 2.0 (the "License"); you may
+      not use this file except in compliance with the License. You may obtain
+      a copy of the License at
+
+          http://www.apache.org/licenses/LICENSE-2.0
+
+      Unless required by applicable law or agreed to in writing, software
+      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+      License for the specific language governing permissions and limitations
+      under the License.
+
+
+OpenStack Resource Types
+------------------------
+.. resourcepages:: OS::
diff --git a/doc/source/template_guide/rackspace.rst b/doc/source/template_guide/rackspace.rst
new file mode 100644
index 00000000..6ba4e2e6
--- /dev/null
+++ b/doc/source/template_guide/rackspace.rst
@@ -0,0 +1,16 @@
+..
+      Licensed under the Apache License, Version 2.0 (the "License"); you may
+      not use this file except in compliance with the License. You may obtain
+      a copy of the License at
+
+          http://www.apache.org/licenses/LICENSE-2.0
+
+      Unless required by applicable law or agreed to in writing, software
+      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+      License for the specific language governing permissions and limitations
+      under the License.
+
+Rackspace Cloud Resource Types
+------------------------------
+.. resourcepages:: Rackspace::
\ No newline at end of file