From 79dfd5fa9e4857b60d7fa96ab6e8c60af8f26e7e Mon Sep 17 00:00:00 2001 From: Terry Howe Date: Fri, 22 May 2015 16:06:26 -0700 Subject: [PATCH] Image resource docs framework Change-Id: I476605070fa94b410f47fd6ff66a645217332e60 --- doc/source/users/index.rst | 1 + doc/source/users/resources/image/index.rst | 17 +++++++++++++++++ doc/source/users/resources/image/v1/image.rst | 12 ++++++++++++ doc/source/users/resources/image/v2/image.rst | 12 ++++++++++++ doc/source/users/resources/image/v2/member.rst | 12 ++++++++++++ doc/source/users/resources/image/v2/tag.rst | 12 ++++++++++++ 6 files changed, 66 insertions(+) create mode 100644 doc/source/users/resources/image/index.rst create mode 100644 doc/source/users/resources/image/v1/image.rst create mode 100644 doc/source/users/resources/image/v2/image.rst create mode 100644 doc/source/users/resources/image/v2/member.rst create mode 100644 doc/source/users/resources/image/v2/tag.rst diff --git a/doc/source/users/index.rst b/doc/source/users/index.rst index 740d523a1..42170b765 100644 --- a/doc/source/users/index.rst +++ b/doc/source/users/index.rst @@ -97,6 +97,7 @@ The following services have exposed *Resource* classes. Compute Database Identity + Image Network Orchestration Object Store diff --git a/doc/source/users/resources/image/index.rst b/doc/source/users/resources/image/index.rst new file mode 100644 index 000000000..3cd17ed8d --- /dev/null +++ b/doc/source/users/resources/image/index.rst @@ -0,0 +1,17 @@ +Image v1 Resources +================== + +.. toctree:: + :maxdepth: 1 + + v1/image + +Image v2 Resources +================== + +.. toctree:: + :maxdepth: 1 + + v2/image + v2/member + v2/tag diff --git a/doc/source/users/resources/image/v1/image.rst b/doc/source/users/resources/image/v1/image.rst new file mode 100644 index 000000000..7f5dffd83 --- /dev/null +++ b/doc/source/users/resources/image/v1/image.rst @@ -0,0 +1,12 @@ +openstack.image.v1.image +======================== + +.. automodule:: openstack.image.v1.image + +The Image Class +--------------- + +The ``Image`` class inherits from :class:`~openstack.resource.Resource`. + +.. autoclass:: openstack.image.v1.image.Image + :members: diff --git a/doc/source/users/resources/image/v2/image.rst b/doc/source/users/resources/image/v2/image.rst new file mode 100644 index 000000000..5d51cba10 --- /dev/null +++ b/doc/source/users/resources/image/v2/image.rst @@ -0,0 +1,12 @@ +openstack.image.v2.image +======================== + +.. automodule:: openstack.image.v2.image + +The Image Class +--------------- + +The ``Image`` class inherits from :class:`~openstack.resource.Resource`. + +.. autoclass:: openstack.image.v2.image.Image + :members: diff --git a/doc/source/users/resources/image/v2/member.rst b/doc/source/users/resources/image/v2/member.rst new file mode 100644 index 000000000..03107fdc0 --- /dev/null +++ b/doc/source/users/resources/image/v2/member.rst @@ -0,0 +1,12 @@ +openstack.image.v2.member +========================= + +.. automodule:: openstack.image.v2.member + +The Member Class +---------------- + +The ``Member`` class inherits from :class:`~openstack.resource.Resource`. + +.. autoclass:: openstack.image.v2.member.Member + :members: diff --git a/doc/source/users/resources/image/v2/tag.rst b/doc/source/users/resources/image/v2/tag.rst new file mode 100644 index 000000000..1947fc827 --- /dev/null +++ b/doc/source/users/resources/image/v2/tag.rst @@ -0,0 +1,12 @@ +openstack.image.v2.tag +====================== + +.. automodule:: openstack.image.v2.tag + +The Tag Class +------------- + +The ``Tag`` class inherits from :class:`~openstack.resource.Resource`. + +.. autoclass:: openstack.image.v2.tag.Tag + :members: