From 4af4c719a87731c61757adee8a28e83f8aee95f8 Mon Sep 17 00:00:00 2001 From: Steve Baker Date: Fri, 26 Jul 2013 09:04:12 +1200 Subject: [PATCH] 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 --- doc/source/template_guide/cfn.rst | 16 ++++++++++++++++ doc/source/template_guide/index.rst | 5 ++++- doc/source/template_guide/openstack.rst | 17 +++++++++++++++++ doc/source/template_guide/rackspace.rst | 16 ++++++++++++++++ 4 files changed, 53 insertions(+), 1 deletion(-) create mode 100644 doc/source/template_guide/cfn.rst create mode 100644 doc/source/template_guide/openstack.rst create mode 100644 doc/source/template_guide/rackspace.rst diff --git a/doc/source/template_guide/cfn.rst b/doc/source/template_guide/cfn.rst new file mode 100644 index 000000000..c7f3a213c --- /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 3c5ed7eb9..baf1b53e0 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 000000000..f342a6e0b --- /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 000000000..6ba4e2e6a --- /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