From 4e1e6de6d4af21e93470a0154c75c146a90fafba Mon Sep 17 00:00:00 2001 From: Tony Breeds Date: Thu, 21 Jun 2018 13:11:46 +1000 Subject: [PATCH] Fix docstrings to work with Sphinx 1.7.4 According to the thread at http://lists.openstack.org/pipermail/openstack-dev/2018-May/130581.html some projects including networking-midonet can not build docs with sphinx 1.7.4+ This seems to be becaus the parser is now more strict? This patch *seems* to fix those doc builds Change-Id: Ie96dca126e727fc9a34eece1590a92f7dd3af426 Partial-Bug: 1771092 --- os_vif/plugin.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/os_vif/plugin.py b/os_vif/plugin.py index 56566a6b..5354e88b 100644 --- a/os_vif/plugin.py +++ b/os_vif/plugin.py @@ -51,7 +51,7 @@ class PluginBase(object): :param vif: `os_vif.objects.vif.VIFBase` object. :param instance_info: `os_vif.objects.instance_info.InstanceInfo` object. - :raises `processutils.ProcessExecutionError`. Plugins implementing + :raises: `processutils.ProcessExecutionError`. Plugins implementing this method should let `processutils.ProcessExecutionError` bubble up. """ @@ -64,7 +64,7 @@ class PluginBase(object): :param vif: `os_vif.objects.vif.VIFBase` object. :param instance_info: `os_vif.objects.instance_info.InstanceInfo` object. - :raises `processutils.ProcessExecutionError`. Plugins implementing + :raises: `processutils.ProcessExecutionError`. Plugins implementing this method should let `processutils.ProcessExecutionError` bubble up. """