openstack
/
heat
Code Issues Proposed changes

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
This commit is contained in:
Steve Baker 2013-07-26 09:04:12 +12:00
parent ad945070a2
commit 4af4c719a8
4 changed files with 53 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/source/template_guide/cfn.rst Normal file
View File

@ -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::

5
doc/source/template_guide/index.rst
View File

@ -17,4 +17,7 @@ Template Guide
.. toctree::
:maxdepth: 2
functions
functions
openstack
cfn
rackspace

17
doc/source/template_guide/openstack.rst Normal file
View File

@ -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::

16
doc/source/template_guide/rackspace.rst Normal file
View File

@ -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::