Cleanup various Sphinx warnings during doc build

This primarily cleans up doc files and mentions for modules which no
longer exist. There's one cleanup to a docstring in the Compute proxy
about a long class being split on two lines without a continuation
backslash.

Change-Id: I9f40d17789d7587e6964c3b655f4dae226dfc6a8
This commit is contained in:
Brian Curtin
2017-02-02 14:35:48 -05:00
parent ed5d3570f7
commit 93894627ec
11 changed files with 7 additions and 72 deletions

View File

@@ -8,4 +8,4 @@ Bare Metal Resources
v1/chassis v1/chassis
v1/node v1/node
v1/port v1/port
v1/portgroup v1/port_group

View File

@@ -12,5 +12,3 @@ Compute Resources
v2/server v2/server
v2/server_interface v2/server_interface
v2/server_ip v2/server_ip
v2/server_meta
v2/server_metadata

View File

@@ -19,10 +19,10 @@ The ``AbsoluteLimits`` class inherits from :class:`~openstack.resource.Resource`
.. autoclass:: openstack.compute.v2.limits.AbsoluteLimits .. autoclass:: openstack.compute.v2.limits.AbsoluteLimits
:members: :members:
The RateLimits Class The RateLimit Class
-------------------- -------------------
The ``RateLimits`` class inherits from :class:`~openstack.resource.Resource`. The ``RateLimit`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.compute.v2.limits.RateLimits .. autoclass:: openstack.compute.v2.limits.RateLimit
:members: :members:

View File

@@ -1,12 +0,0 @@
openstack.compute.v2.server_meta
================================
.. automodule:: openstack.compute.v2.server_meta
The ServerMeta Class
--------------------
The ``ServerMeta`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.compute.v2.server_meta.ServerMeta
:members:

View File

@@ -1,12 +0,0 @@
openstack.compute.v2.server_metadata
====================================
.. automodule:: openstack.compute.v2.server_metadata
The ServerMetadata Class
------------------------
The ``ServerMetadata`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.compute.v2.server_metadata.ServerMetadata
:members:

View File

@@ -14,4 +14,3 @@ Image v2 Resources
v2/image v2/image
v2/member v2/member
v2/tag

View File

@@ -1,12 +0,0 @@
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:

View File

@@ -4,8 +4,6 @@ Telemetry Resources
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
v2/alarm
v2/alarm_change
v2/capability v2/capability
v2/meter v2/meter
v2/resource v2/resource

View File

@@ -1,12 +0,0 @@
openstack.telemetry.v2.alarm
============================
.. automodule:: openstack.telemetry.v2.alarm
The Alarm Class
---------------
The ``Alarm`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.telemetry.v2.alarm.Alarm
:members:

View File

@@ -1,12 +0,0 @@
openstack.telemetry.v2.alarm_change
===================================
.. automodule:: openstack.telemetry.v2.alarm_change
The AlarmChange Class
---------------------
The ``AlarmChange`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.telemetry.v2.alarm_change.AlarmChange
:members:

View File

@@ -884,8 +884,8 @@ class Proxy(proxy2.BaseProxy):
requires extra permission. requires extra permission.
:returns: A generator of availability zone :returns: A generator of availability zone
:rtype: :class:`~openstack.compute.v2.availability_zone. :rtype: :class:`~openstack.compute.v2.availability_zone.\
AvailabilityZone` AvailabilityZone`
""" """
if details: if details:
az = availability_zone.AvailabilityZoneDetail az = availability_zone.AvailabilityZoneDetail