Open Stack

On Wed, May 16, 2018 at 04:14:36PM -0500, Matthew Thode wrote:
> On 18-05-16 17:07:09, Doug Hellmann wrote:
> > Excerpts from Matthew Thode's message of 2018-05-16 15:59:47 -0500:
> > > Sphinx has breaking changes (yet again) and we need to figure out how to
> > > deal with it.  I think the fix will be simple for affected projects, but
> > > we should probably move forward on this.  The error people are getting
> > > seems to be 'Field list ends without a blank line; unexpected unindent.'
> > > 
> > > I'd like to keep on 1.7.4 and have the affected projects fix the error
> > > so we can move on, but the revert has been proposed (and approved to get
> > > gate unbroken for them).  https://review.openstack.org/568248  Any
> > > advice from the community is welcome.
> > > 
> > 
> > Is it sphinx, or docutils?
> > 
> > Do you have an example of the error?
> > 
> 
> From https://bugs.launchpad.net/networking-midonet/+bug/1771092
> 
> 2018-05-13 14:22:06.176410 | ubuntu-xenial | Warning, treated as error:
> 2018-05-13 14:22:06.176967 | ubuntu-xenial | /home/zuul/src/git.openstack.org/openstack/networking-midonet/midonet/neutron/db/l3_db_midonet.py:docstring of midonet.neutron.db.l3_db_midonet.MidonetL3DBMixin.get_router_for_floatingip:8:Field list ends without a blank line; unexpected unindent.
> 

Adding something like:

(.docs) [tony at thor networking-midonet]$ ( cd ../neutron && git diff )
diff --git a/neutron/db/l3_db.py b/neutron/db/l3_db.py
index 33b5d99b1..66794542a 100644
--- a/neutron/db/l3_db.py
+++ b/neutron/db/l3_db.py
@@ -1091,8 +1091,8 @@ class L3_NAT_dbonly_mixin(l3.RouterPluginBase,
         :param internal_subnet: The subnet for the fixed-ip.
         :param external_network_id: The external network for floating-ip.
 
-        :raises: ExternalGatewayForFloatingIPNotFound if no suitable router
-        is found.
+        :raises: ExternalGatewayForFloatingIPNotFound if no suitable router \
+                 is found.
         """
 
         # Find routers(with router_id and interface address) that
(.docs) [tony at thor networking-midonet]$ ( cd ../os-vif && git diff )
diff --git a/os_vif/plugin.py b/os_vif/plugin.py
index 56566a6..2a437a6 100644
--- a/os_vif/plugin.py
+++ b/os_vif/plugin.py
@@ -49,10 +49,11 @@ class PluginBase(object):
         Given a model of a VIF, perform operations to plug the VIF properly.
 
         :param vif: `os_vif.objects.vif.VIFBase` object.
-        :param instance_info: `os_vif.objects.instance_info.InstanceInfo`
-            object.
-        :raises `processutils.ProcessExecutionError`. Plugins implementing
-                this method should let `processutils.ProcessExecutionError`
+        :param instance_info: `os_vif.objects.instance_info.InstanceInfo` \
+                              object.
+
+        :raises `processutils.ProcessExecutionError`. Plugins implementing \
+                this method should let `processutils.ProcessExecutionError` \
                 bubble up.
         """
 
@@ -63,9 +64,10 @@ 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
-                this method should let `processutils.ProcessExecutionError`
+                              object.
+
+        :raises `processutils.ProcessExecutionError`. Plugins implementing \
+                this method should let `processutils.ProcessExecutionError` \
                 bubble up.
         """
 
fixes the midonet docs build for me (locally) on sphinx 1.7.4.  I'm far from a
sphinx expert but the chnages to neutron and os-vif seem correct to me.

Perhaps the sphinx parser just got more strict?

Yours Tony.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 488 bytes
Desc: not available
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20180517/b5e31fbc/attachment.sig>