docs: Add missing docs for compute resources

Change-Id: I34dd2cd97451b04da7f4db7d6868572aafdeec70 Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2023-08-16 18:41:23 +01:00 · 2023-08-16 18:41:23 +01:00 · d06ac50e7d
parent 19ba0adc33
commit d06ac50e7d
11 changed files with 146 additions and 12 deletions
--- a/doc/source/user/resources/compute/index.rst
+++ b/doc/source/user/resources/compute/index.rst
@ -3,16 +3,7 @@ Compute Resources

 .. toctree::
   :maxdepth: 1
+   :glob:

-   v2/extension
-   v2/flavor
-   v2/image
-   v2/keypair
-   v2/limits
-   v2/migration
-   v2/server
-   v2/server_interface
-   v2/server_migration
-   v2/server_ip
-   v2/hypervisor
-   v2/quota_set
+   v2/*
+   version
--- a/doc/source/user/resources/compute/v2/aggregate.rst
+++ b/doc/source/user/resources/compute/v2/aggregate.rst
@ -0,0 +1,12 @@
+openstack.compute.v2.aggregate
+==============================
+
+.. automodule:: openstack.compute.v2.aggregate
+
+The Aggregate Class
+-------------------
+
+The ``Aggregate`` class inherits from :class:`~openstack.resource.Resource`.
+
+.. autoclass:: openstack.compute.v2.aggregate.Aggregate
+   :members:
--- a/doc/source/user/resources/compute/v2/availability_zone.rst
+++ b/doc/source/user/resources/compute/v2/availability_zone.rst
@ -0,0 +1,13 @@
+openstack.compute.v2.availability_zone
+======================================
+
+.. automodule:: openstack.compute.v2.availability_zone
+
+The AvailabilityZone Class
+--------------------------
+
+The ``AvailabilityZone`` class inherits from
+:class:`~openstack.resource.Resource`.
+
+.. autoclass:: openstack.compute.v2.availability_zone.AvailabilityZone
+   :members:
--- a/doc/source/user/resources/compute/v2/server_action.rst
+++ b/doc/source/user/resources/compute/v2/server_action.rst
@ -0,0 +1,22 @@
+openstack.compute.v2.server_action
+==================================
+
+.. automodule:: openstack.compute.v2.server_action
+
+The ServerAction Class
+----------------------
+
+The ``ServerAction`` class inherits from
+:class:`~openstack.resource.Resource`.
+
+.. autoclass:: openstack.compute.v2.server_action.ServerAction
+   :members:
+
+The ServerActionEvent Class
+---------------------------
+
+The ``ServerActionEvent`` class inherits from
+:class:`~openstack.resource.Resource`.
+
+.. autoclass:: openstack.compute.v2.server_action.ServerActionEvent
+   :members:
--- a/doc/source/user/resources/compute/v2/server_diagnostics.rst
+++ b/doc/source/user/resources/compute/v2/server_diagnostics.rst
@ -0,0 +1,13 @@
+openstack.compute.v2.server_diagnostics
+=======================================
+
+.. automodule:: openstack.compute.v2.server_diagnostics
+
+The ServerDiagnostics Class
+---------------------------
+
+The ``ServerDiagnostics`` class inherits from
+:class:`~openstack.resource.Resource`.
+
+.. autoclass:: openstack.compute.v2.server_diagnostics.ServerDiagnostics
+   :members:
--- a/doc/source/user/resources/compute/v2/server_group.rst
+++ b/doc/source/user/resources/compute/v2/server_group.rst
@ -0,0 +1,13 @@
+openstack.compute.v2.server_group
+=================================
+
+.. automodule:: openstack.compute.v2.server_group
+
+The ServerGroup Class
+---------------------
+
+The ``ServerGroup`` class inherits from
+:class:`~openstack.resource.Resource`.
+
+.. autoclass:: openstack.compute.v2.server_group.ServerGroup
+   :members:
--- a/doc/source/user/resources/compute/v2/server_remote_console.rst
+++ b/doc/source/user/resources/compute/v2/server_remote_console.rst
@ -0,0 +1,13 @@
+openstack.compute.v2.server_remote_console
+==========================================
+
+.. automodule:: openstack.compute.v2.server_remote_console
+
+The ServerRemoteConsole Class
+-----------------------------
+
+The ``ServerRemoteConsole`` class inherits from
+:class:`~openstack.resource.Resource`.
+
+.. autoclass:: openstack.compute.v2.server_remote_console.ServerRemoteConsole
+   :members:
--- a/doc/source/user/resources/compute/v2/service.rst
+++ b/doc/source/user/resources/compute/v2/service.rst
@ -0,0 +1,12 @@
+openstack.compute.v2.service
+============================
+
+.. automodule:: openstack.compute.v2.service
+
+The Service Class
+-----------------
+
+The ``Service`` class inherits from :class:`~openstack.resource.Resource`.
+
+.. autoclass:: openstack.compute.v2.service.Service
+   :members:
--- a/doc/source/user/resources/compute/v2/usage.rst
+++ b/doc/source/user/resources/compute/v2/usage.rst
@ -0,0 +1,20 @@
+openstack.compute.v2.usage
+==========================
+
+.. automodule:: openstack.compute.v2.usage
+
+The Usage Class
+---------------
+
+The ``Usage`` class inherits from :class:`~openstack.resource.Resource`.
+
+.. autoclass:: openstack.compute.v2.usage.Usage
+   :members:
+
+The ServerUsage Class
+---------------------
+
+The ``ServerUsage`` class inherits from :class:`~openstack.resource.Resource`.
+
+.. autoclass:: openstack.compute.v2.usage.ServerUsage
+   :members:
--- a/doc/source/user/resources/compute/v2/volume_attachment.rst
+++ b/doc/source/user/resources/compute/v2/volume_attachment.rst
@ -0,0 +1,13 @@
+openstack.compute.v2.volume_attachment
+======================================
+
+.. automodule:: openstack.compute.v2.volume_attachment
+
+The VolumeAttachment Class
+--------------------------
+
+The ``VolumeAttachment`` class inherits from
+:class:`~openstack.resource.Resource`.
+
+.. autoclass:: openstack.compute.v2.volume_attachment.VolumeAttachment
+   :members:
--- a/doc/source/user/resources/compute/version.rst
+++ b/doc/source/user/resources/compute/version.rst
@ -0,0 +1,12 @@
+openstack.compute.version
+=========================
+
+.. automodule:: openstack.compute.version
+
+The Version Class
+-----------------
+
+The ``Version`` class inherits from :class:`~openstack.resource.Resource`.
+
+.. autoclass:: openstack.compute.version.Version
+   :members: