openstack/nova
Code Issues Proposed changes

Remove dead link from notification devref

Browse Source 
The auto generated class documentation link was 404 in the notification
devref as that documenation is not generated automatically any more.

This patch modifies the notification devref to include the interesting
part of the class documentation inline.

Change-Id: I7cbea16fc9682fa3c00eac16a51c4ed8588ba45c
This commit is contained in:
Balazs Gibizer 2016-10-10 16:37:13 +02:00
parent 26fd2eabb0
commit 39af8d5d70
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/notifications.rst
View File

@ -113,7 +113,14 @@ already defines three mandatory fields of the notification `event_type`,
notifications shall inherit from the
`nova.objects.notifications.base.NotificationPayloadBase` class and shall
define the fields of the payload as versionedobject fields. The base classes
are described in [3]_.
are described in the following section.
The nova.notifications.objects.base module
..........................................
.. automodule:: nova.notifications.objects.base
:noindex:
:members:
:show-inheritance:
Please note that the notification objects shall not be registered to the
NovaObjectRegistry to avoid mixing nova internal objects with the notification
@ -278,4 +285,3 @@ Existing versioned notifications
.. [1] http://docs.openstack.org/developer/oslo.messaging/notifier.html
.. [2] http://docs.openstack.org/developer/oslo.versionedobjects
.. [3] http://docs.openstack.org/developer/nova/devref/api/nova.objects.notification.html