Re: [openstack-dev] [all][requirements][docs] sphinx update to 1.7.4 from 1.6.5

[Vladyslav Drok]

On Tue, Jun 26, 2018 at 5:14 PM Vladyslav Drok  wrote:

>
> On Tue, Jun 26, 2018 at 4:58 PM Takashi Yamamoto 
> wrote:
>
>> On Tue, Jun 26, 2018 at 10:13 PM, Doug Hellmann 
>> wrote:
>> > Excerpts from Lance Bragstad's message of 2018-06-25 22:51:37 -0500:
>> >> Thanks a bunch for digging into this, Tony. I'll follow up with the
>> >> oauthlib maintainers and see if they'd be interested in these changes
>> >> upstream. If so, I can chip away at it. For now we'll have to settle
>> for
>> >> not treating warnings as errors to unblock our documentation gate [0].
>> >>
>> >> [0] https://review.openstack.org/#/c/577974/
>> >
>> > How are docstrings from a third-party library making their way into the
>> > keystone docs and breaking the build?
>>
>> in the same way that docstrings from os-vif affect networking-midonet
>> docs.
>> i.e. via class inheritance
>>
>> >
>> > Doug
>> >
>> >>
>> >> On 06/25/2018 07:27 PM, Tony Breeds wrote:
>> >> > On Mon, Jun 25, 2018 at 05:42:00PM -0500, Lance Bragstad wrote:
>> >> >> Keystone is hitting this, too [0]. I attempted the same solution
>> that
>> >> >> Tony posted, but no luck. I've even gone so far as removing every
>> >> >> comment from the module to see if that helps narrow down the problem
>> >> >> area, but sphinx still trips. The output from the error message
>> isn't
>> >> >> very descriptive either. Has anyone else had issues fixing this for
>> >> >> python comments, not just docstrings?
>> >> >>
>> >> >> [0] https://bugs.launchpad.net/keystone/+bug/1778603
>> >> > I did a little digging for the keystone problem and it's due to a
>> >> > missing ':' in
>> >> >
>> https://github.com/oauthlib/oauthlib/blob/master/oauthlib/oauth1/rfc5849/request_validator.py#L819-L820
>> >> >
>> >> > So the correct way to fix this is to correct that in oauthlib, get it
>> >> > released and use that.
>> >> >
>> >> > I hit additional problems in that enabling -W in oauthlib, to pevent
>> >> > this happening in the future, lead me down a rabbit hole I don't
>> really
>> >> > have cycles to dig out of.
>> >> >
>> >> > Here's a dump of where I got to[1].  Clearly it mixes "fixes" with
>> >> > debugging but it isn't too hard to reproduce and someone that knows
>> more
>> >> > Sphinx will be able to understand the errors better than I can.
>> >> >
>> >> >
>> >> > [1] http://paste.openstack.org/show/724271/
>> >> >
>> >> > Yours Tony.
>>
>
> This also might be related to this thread, in ironic I can see the
> following while building the docs, apart from 'Bullet list ends without a
> blank line' issue:
>
> Warning, treated as error:
> /home/vlad/work/ironic/ironic/api/app.py:docstring of
> ironic.api.app.IronicCORS:1:Error in "wsme:service" directive:
> unknown option: "module".
>
> .. wsme:service:: None
>:module: ironic.api.app
>
>Bases: :class:`oslo_middleware.cors.CORS`
>
>Ironic-specific CORS class
>
>We're adding the Ironic-specific version headers to the list of simple
>headers in order that a request bearing those headers might be accepted
> by
>the Ironic REST API.
>
> I see that there is some code in wsmeext that should be dealing with that
> if I understand correctly --
> https://github.com/openstack/wsme/blob/0.8.0/wsmeext/sphinxext.py#L356-L357
>
> Sphinx version I have is 1.7.5.
>
> Several other folks indicated that they hit it with on fresh fedora.
>

It also appears that index of :module: entry has changed:

-> if ':module:' in self.directive.result[-1]:
(Pdb) self.directive.result
ViewList(['', '.. py:module:: ironic.api.app', '', '', '.. wsme:service::
None', '   :module: ironic.api.app', '', '   Bases:
:class:`oslo_middleware.cors.CORS`'],
items=[('/home/vlad/work/ironic/ironic/api/app.py:docstring of
ironic.api.app', 0), ('/home/vlad/work/ironic/ironic/api/app.py:docstring
of ironic.api.app', 0),
('/home/vlad/work/ironic/ironic/api/app.py:docstring of ironic.api.app',
0), ('/home/vlad/work/ironic/ironic/api/app.py:docstring of
ironic.api.app.IronicCORS', 0),
('/home/vlad/work/ironic/ironic/api/app.py:docstring of
ironic.api.app.IronicCORS', 0),
('/home/vlad/work/ironic/ironic/api/app.py:docstring of
ironic.api.app.IronicCORS', 0),
('/home/vlad/work/ironic/ironic/api/app.py:docstring of
ironic.api.app.IronicCORS', 0),
('/home/vlad/work/ironic/ironic/api/app.py:docstring of
ironic.api.app.IronicCORS', 0)])

It is self.directive.result[-3] now, so I guess it needs to be changed to
iterate on everything in that list with that check?


>
>> >> >
>> >> >
>> >> >
>> __
>> >> > OpenStack Development Mailing List (not for usage questions)
>> >> > Unsubscribe:
>> openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
>> >> > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>> >
>> >
>> __
>> > OpenStack Development Mailing List (not for usage questions)
>> > Unsubscribe:
>> 

Re: [openstack-dev] [all][requirements][docs] sphinx update to 1.7.4 from 1.6.5

[Vladyslav Drok]

On Tue, Jun 26, 2018 at 4:58 PM Takashi Yamamoto 
wrote:

> On Tue, Jun 26, 2018 at 10:13 PM, Doug Hellmann 
> wrote:
> > Excerpts from Lance Bragstad's message of 2018-06-25 22:51:37 -0500:
> >> Thanks a bunch for digging into this, Tony. I'll follow up with the
> >> oauthlib maintainers and see if they'd be interested in these changes
> >> upstream. If so, I can chip away at it. For now we'll have to settle for
> >> not treating warnings as errors to unblock our documentation gate [0].
> >>
> >> [0] https://review.openstack.org/#/c/577974/
> >
> > How are docstrings from a third-party library making their way into the
> > keystone docs and breaking the build?
>
> in the same way that docstrings from os-vif affect networking-midonet docs.
> i.e. via class inheritance
>
> >
> > Doug
> >
> >>
> >> On 06/25/2018 07:27 PM, Tony Breeds wrote:
> >> > On Mon, Jun 25, 2018 at 05:42:00PM -0500, Lance Bragstad wrote:
> >> >> Keystone is hitting this, too [0]. I attempted the same solution that
> >> >> Tony posted, but no luck. I've even gone so far as removing every
> >> >> comment from the module to see if that helps narrow down the problem
> >> >> area, but sphinx still trips. The output from the error message isn't
> >> >> very descriptive either. Has anyone else had issues fixing this for
> >> >> python comments, not just docstrings?
> >> >>
> >> >> [0] https://bugs.launchpad.net/keystone/+bug/1778603
> >> > I did a little digging for the keystone problem and it's due to a
> >> > missing ':' in
> >> >
> https://github.com/oauthlib/oauthlib/blob/master/oauthlib/oauth1/rfc5849/request_validator.py#L819-L820
> >> >
> >> > So the correct way to fix this is to correct that in oauthlib, get it
> >> > released and use that.
> >> >
> >> > I hit additional problems in that enabling -W in oauthlib, to pevent
> >> > this happening in the future, lead me down a rabbit hole I don't
> really
> >> > have cycles to dig out of.
> >> >
> >> > Here's a dump of where I got to[1].  Clearly it mixes "fixes" with
> >> > debugging but it isn't too hard to reproduce and someone that knows
> more
> >> > Sphinx will be able to understand the errors better than I can.
> >> >
> >> >
> >> > [1] http://paste.openstack.org/show/724271/
> >> >
> >> > Yours Tony.
>

This also might be related to this thread, in ironic I can see the
following while building the docs, apart from 'Bullet list ends without a
blank line' issue:

Warning, treated as error:
/home/vlad/work/ironic/ironic/api/app.py:docstring of
ironic.api.app.IronicCORS:1:Error in "wsme:service" directive:
unknown option: "module".

.. wsme:service:: None
   :module: ironic.api.app

   Bases: :class:`oslo_middleware.cors.CORS`

   Ironic-specific CORS class

   We're adding the Ironic-specific version headers to the list of simple
   headers in order that a request bearing those headers might be accepted
by
   the Ironic REST API.

I see that there is some code in wsmeext that should be dealing with that
if I understand correctly --
https://github.com/openstack/wsme/blob/0.8.0/wsmeext/sphinxext.py#L356-L357

Sphinx version I have is 1.7.5.

Several other folks indicated that they hit it with on fresh fedora.


> >> >
> >> >
> >> >
> __
> >> > OpenStack Development Mailing List (not for usage questions)
> >> > Unsubscribe:
> openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
> >> > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
> >
> >
> __
> > OpenStack Development Mailing List (not for usage questions)
> > Unsubscribe:
> openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
> > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>
> __
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>
__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Re: [openstack-dev] [all][requirements][docs] sphinx update to 1.7.4 from 1.6.5

[Lance Bragstad]

On 06/26/2018 08:57 AM, Takashi Yamamoto wrote:
> On Tue, Jun 26, 2018 at 10:13 PM, Doug Hellmann  wrote:
>> Excerpts from Lance Bragstad's message of 2018-06-25 22:51:37 -0500:
>>> Thanks a bunch for digging into this, Tony. I'll follow up with the
>>> oauthlib maintainers and see if they'd be interested in these changes
>>> upstream. If so, I can chip away at it. For now we'll have to settle for
>>> not treating warnings as errors to unblock our documentation gate [0].
>>>
>>> [0] https://review.openstack.org/#/c/577974/
>> How are docstrings from a third-party library making their way into the
>> keystone docs and breaking the build?
> in the same way that docstrings from os-vif affect networking-midonet docs.
> i.e. via class inheritance

Correct, keystone relies in an interface from that library. I've reached
out to their community to see if they would be interested in the fixes
upstream [0], and they were receptive. Until then we might have to
override the offending documentation strings somehow (per Doug's
suggestion in IRC) or disable warning as errors in our build [1].

[0] https://github.com/oauthlib/oauthlib/issues/558
[1] https://review.openstack.org/#/c/577974/

>
>> Doug
>>
>>> On 06/25/2018 07:27 PM, Tony Breeds wrote:
 On Mon, Jun 25, 2018 at 05:42:00PM -0500, Lance Bragstad wrote:
> Keystone is hitting this, too [0]. I attempted the same solution that
> Tony posted, but no luck. I've even gone so far as removing every
> comment from the module to see if that helps narrow down the problem
> area, but sphinx still trips. The output from the error message isn't
> very descriptive either. Has anyone else had issues fixing this for
> python comments, not just docstrings?
>
> [0] https://bugs.launchpad.net/keystone/+bug/1778603
 I did a little digging for the keystone problem and it's due to a
 missing ':' in
 https://github.com/oauthlib/oauthlib/blob/master/oauthlib/oauth1/rfc5849/request_validator.py#L819-L820

 So the correct way to fix this is to correct that in oauthlib, get it
 released and use that.

 I hit additional problems in that enabling -W in oauthlib, to pevent
 this happening in the future, lead me down a rabbit hole I don't really
 have cycles to dig out of.

 Here's a dump of where I got to[1].  Clearly it mixes "fixes" with
 debugging but it isn't too hard to reproduce and someone that knows more
 Sphinx will be able to understand the errors better than I can.


 [1] http://paste.openstack.org/show/724271/

 Yours Tony.


 __
 OpenStack Development Mailing List (not for usage questions)
 Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
 http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>> __
>> OpenStack Development Mailing List (not for usage questions)
>> Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
> __
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev




signature.asc
Description: OpenPGP digital signature
__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Re: [openstack-dev] [all][requirements][docs] sphinx update to 1.7.4 from 1.6.5

[Takashi Yamamoto]

On Tue, Jun 26, 2018 at 10:13 PM, Doug Hellmann  wrote:
> Excerpts from Lance Bragstad's message of 2018-06-25 22:51:37 -0500:
>> Thanks a bunch for digging into this, Tony. I'll follow up with the
>> oauthlib maintainers and see if they'd be interested in these changes
>> upstream. If so, I can chip away at it. For now we'll have to settle for
>> not treating warnings as errors to unblock our documentation gate [0].
>>
>> [0] https://review.openstack.org/#/c/577974/
>
> How are docstrings from a third-party library making their way into the
> keystone docs and breaking the build?

in the same way that docstrings from os-vif affect networking-midonet docs.
i.e. via class inheritance

>
> Doug
>
>>
>> On 06/25/2018 07:27 PM, Tony Breeds wrote:
>> > On Mon, Jun 25, 2018 at 05:42:00PM -0500, Lance Bragstad wrote:
>> >> Keystone is hitting this, too [0]. I attempted the same solution that
>> >> Tony posted, but no luck. I've even gone so far as removing every
>> >> comment from the module to see if that helps narrow down the problem
>> >> area, but sphinx still trips. The output from the error message isn't
>> >> very descriptive either. Has anyone else had issues fixing this for
>> >> python comments, not just docstrings?
>> >>
>> >> [0] https://bugs.launchpad.net/keystone/+bug/1778603
>> > I did a little digging for the keystone problem and it's due to a
>> > missing ':' in
>> > https://github.com/oauthlib/oauthlib/blob/master/oauthlib/oauth1/rfc5849/request_validator.py#L819-L820
>> >
>> > So the correct way to fix this is to correct that in oauthlib, get it
>> > released and use that.
>> >
>> > I hit additional problems in that enabling -W in oauthlib, to pevent
>> > this happening in the future, lead me down a rabbit hole I don't really
>> > have cycles to dig out of.
>> >
>> > Here's a dump of where I got to[1].  Clearly it mixes "fixes" with
>> > debugging but it isn't too hard to reproduce and someone that knows more
>> > Sphinx will be able to understand the errors better than I can.
>> >
>> >
>> > [1] http://paste.openstack.org/show/724271/
>> >
>> > Yours Tony.
>> >
>> >
>> > __
>> > OpenStack Development Mailing List (not for usage questions)
>> > Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
>> > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>
> __
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Re: [openstack-dev] [all][requirements][docs] sphinx update to 1.7.4 from 1.6.5

[Doug Hellmann]

Excerpts from Lance Bragstad's message of 2018-06-25 22:51:37 -0500:
> Thanks a bunch for digging into this, Tony. I'll follow up with the
> oauthlib maintainers and see if they'd be interested in these changes
> upstream. If so, I can chip away at it. For now we'll have to settle for
> not treating warnings as errors to unblock our documentation gate [0].
> 
> [0] https://review.openstack.org/#/c/577974/

How are docstrings from a third-party library making their way into the
keystone docs and breaking the build?

Doug

> 
> On 06/25/2018 07:27 PM, Tony Breeds wrote:
> > On Mon, Jun 25, 2018 at 05:42:00PM -0500, Lance Bragstad wrote:
> >> Keystone is hitting this, too [0]. I attempted the same solution that
> >> Tony posted, but no luck. I've even gone so far as removing every
> >> comment from the module to see if that helps narrow down the problem
> >> area, but sphinx still trips. The output from the error message isn't
> >> very descriptive either. Has anyone else had issues fixing this for
> >> python comments, not just docstrings?
> >>
> >> [0] https://bugs.launchpad.net/keystone/+bug/1778603
> > I did a little digging for the keystone problem and it's due to a
> > missing ':' in 
> > https://github.com/oauthlib/oauthlib/blob/master/oauthlib/oauth1/rfc5849/request_validator.py#L819-L820
> >
> > So the correct way to fix this is to correct that in oauthlib, get it
> > released and use that.
> >
> > I hit additional problems in that enabling -W in oauthlib, to pevent
> > this happening in the future, lead me down a rabbit hole I don't really
> > have cycles to dig out of.
> >
> > Here's a dump of where I got to[1].  Clearly it mixes "fixes" with
> > debugging but it isn't too hard to reproduce and someone that knows more
> > Sphinx will be able to understand the errors better than I can.
> >
> >
> > [1] http://paste.openstack.org/show/724271/
> >
> > Yours Tony.
> >
> >
> > __
> > OpenStack Development Mailing List (not for usage questions)
> > Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
> > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Re: [openstack-dev] [all][requirements][docs] sphinx update to 1.7.4 from 1.6.5

[Lance Bragstad]

Thanks a bunch for digging into this, Tony. I'll follow up with the
oauthlib maintainers and see if they'd be interested in these changes
upstream. If so, I can chip away at it. For now we'll have to settle for
not treating warnings as errors to unblock our documentation gate [0].

[0] https://review.openstack.org/#/c/577974/

On 06/25/2018 07:27 PM, Tony Breeds wrote:
> On Mon, Jun 25, 2018 at 05:42:00PM -0500, Lance Bragstad wrote:
>> Keystone is hitting this, too [0]. I attempted the same solution that
>> Tony posted, but no luck. I've even gone so far as removing every
>> comment from the module to see if that helps narrow down the problem
>> area, but sphinx still trips. The output from the error message isn't
>> very descriptive either. Has anyone else had issues fixing this for
>> python comments, not just docstrings?
>>
>> [0] https://bugs.launchpad.net/keystone/+bug/1778603
> I did a little digging for the keystone problem and it's due to a
> missing ':' in 
> https://github.com/oauthlib/oauthlib/blob/master/oauthlib/oauth1/rfc5849/request_validator.py#L819-L820
>
> So the correct way to fix this is to correct that in oauthlib, get it
> released and use that.
>
> I hit additional problems in that enabling -W in oauthlib, to pevent
> this happening in the future, lead me down a rabbit hole I don't really
> have cycles to dig out of.
>
> Here's a dump of where I got to[1].  Clearly it mixes "fixes" with
> debugging but it isn't too hard to reproduce and someone that knows more
> Sphinx will be able to understand the errors better than I can.
>
>
> [1] http://paste.openstack.org/show/724271/
>
> Yours Tony.
>
>
> __
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev



signature.asc
Description: OpenPGP digital signature
__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Re: [openstack-dev] [all][requirements][docs] sphinx update to 1.7.4 from 1.6.5

[Tony Breeds]

On Mon, Jun 25, 2018 at 05:42:00PM -0500, Lance Bragstad wrote:
> Keystone is hitting this, too [0]. I attempted the same solution that
> Tony posted, but no luck. I've even gone so far as removing every
> comment from the module to see if that helps narrow down the problem
> area, but sphinx still trips. The output from the error message isn't
> very descriptive either. Has anyone else had issues fixing this for
> python comments, not just docstrings?
> 
> [0] https://bugs.launchpad.net/keystone/+bug/1778603

I did a little digging for the keystone problem and it's due to a
missing ':' in 
https://github.com/oauthlib/oauthlib/blob/master/oauthlib/oauth1/rfc5849/request_validator.py#L819-L820

So the correct way to fix this is to correct that in oauthlib, get it
released and use that.

I hit additional problems in that enabling -W in oauthlib, to pevent
this happening in the future, lead me down a rabbit hole I don't really
have cycles to dig out of.

Here's a dump of where I got to[1].  Clearly it mixes "fixes" with
debugging but it isn't too hard to reproduce and someone that knows more
Sphinx will be able to understand the errors better than I can.


[1] http://paste.openstack.org/show/724271/

Yours Tony.


signature.asc
Description: PGP signature
__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Re: [openstack-dev] [all][requirements][docs] sphinx update to 1.7.4 from 1.6.5

[Lance Bragstad]

Keystone is hitting this, too [0]. I attempted the same solution that
Tony posted, but no luck. I've even gone so far as removing every
comment from the module to see if that helps narrow down the problem
area, but sphinx still trips. The output from the error message isn't
very descriptive either. Has anyone else had issues fixing this for
python comments, not just docstrings?

[0] https://bugs.launchpad.net/keystone/+bug/1778603

On 06/20/2018 11:52 PM, Takashi Yamamoto wrote:
> On Thu, Jun 21, 2018 at 12:13 PM, Tony Breeds  wrote:
>> On Wed, Jun 20, 2018 at 08:54:56PM +0900, Takashi Yamamoto wrote:
>>
>>> do you have a plan to submit these changes on gerrit?
>> I didn't but I have now:
>>
>>  * https://review.openstack.org/577028
>>  * https://review.openstack.org/577029
>>
>> Feel free to edit/test as you like.
> thank you!
>
>> Yours Tony.
>>
>> __
>> OpenStack Development Mailing List (not for usage questions)
>> Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>>
> __
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev




signature.asc
Description: OpenPGP digital signature
__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Re: [openstack-dev] [all][requirements][docs] sphinx update to 1.7.4 from 1.6.5

[Takashi Yamamoto]

On Thu, Jun 21, 2018 at 12:13 PM, Tony Breeds  wrote:
> On Wed, Jun 20, 2018 at 08:54:56PM +0900, Takashi Yamamoto wrote:
>
>> do you have a plan to submit these changes on gerrit?
>
> I didn't but I have now:
>
>  * https://review.openstack.org/577028
>  * https://review.openstack.org/577029
>
> Feel free to edit/test as you like.

thank you!

>
> Yours Tony.
>
> __
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>

__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Re: [openstack-dev] [all][requirements][docs] sphinx update to 1.7.4 from 1.6.5

[Tony Breeds]

On Wed, Jun 20, 2018 at 08:54:56PM +0900, Takashi Yamamoto wrote:
 
> do you have a plan to submit these changes on gerrit?

I didn't but I have now:

 * https://review.openstack.org/577028
 * https://review.openstack.org/577029

Feel free to edit/test as you like.

Yours Tony.


signature.asc
Description: PGP signature
__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Re: [openstack-dev] [all][requirements][docs] sphinx update to 1.7.4 from 1.6.5

[Takashi Yamamoto]

hi,

On Thu, May 17, 2018 at 12:51 PM, Tony Breeds  wrote:
> 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@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@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.

do you have a plan to submit these changes on gerrit?

>
> Perhaps the sphinx parser just got more strict?
>
> Yours Tony.
>
> __
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>

__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Re: [openstack-dev] [all][requirements][docs] sphinx update to 1.7.4 from 1.6.5

[Matthew Thode]

On 18-05-17 13:51:06, Tony Breeds wrote:
> 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.
> > 
> 
> Perhaps the sphinx parser just got more strict?
> 

Yep

-- 
Matthew Thode (prometheanfire)


signature.asc
Description: PGP signature
__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Re: [openstack-dev] [all][requirements][docs] sphinx update to 1.7.4 from 1.6.5

[Tony Breeds]

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@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@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.


signature.asc
Description: PGP signature
__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Re: [openstack-dev] [all][requirements][docs] sphinx update to 1.7.4 from 1.6.5

[Michael Johnson]

The Octavia project had other breakage due to sphinx > 1.7 but we have
already resolved those issues.

Back story: the way arguments are handled for apidoc changed.
An example patch for the fix would be: https://review.openstack.org/#/c/568383/

Michael (johnsom)

On Wed, May 16, 2018 at 1:59 PM, Matthew Thode
 wrote:
> 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.
>
> --
> Matthew Thode (prometheanfire)
>
> __
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>

__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Re: [openstack-dev] [all][requirements][docs] sphinx update to 1.7.4 from 1.6.5

[Matthew Thode]

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.

-- 
Matthew Thode (prometheanfire)


signature.asc
Description: PGP signature
__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Re: [openstack-dev] [all][requirements][docs] sphinx update to 1.7.4 from 1.6.5

[Doug Hellmann]

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?

__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

[openstack-dev] [all][requirements][docs] sphinx update to 1.7.4 from 1.6.5

[Matthew Thode]

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.

-- 
Matthew Thode (prometheanfire)


signature.asc
Description: PGP signature
__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev