Excerpts from Ihar Hrachyshka's message of 2016-06-21 15:40:45 +0200: > > > On 21 Jun 2016, at 15:01, Doug Hellmann <[email protected]> wrote: > > > > A while back pbr had a feature that let projects pass "warnerror" > > through to Sphinx during documentation builds, causing any warnings in > > that build to be treated as an error and fail the build. This lets us > > avoid things like links to places that don't exist in the docs, bad but > > renderable rst, typos in directive or role names, etc. > > > > Somewhat more recently, but still a while ago, that feature "broke" > > with a Sphinx release that was not API compatible. Sachi King has > > fixed this issue within pbr, and so the next release of pbr will > > fix the broken behavior and start correctly passing warnerror again. > > That may result in doc builds breaking where they didn't before. > > > > The short-term solution is to turn of warnerrors (look in your > > setup.cfg), then fix the issues and turn it back on. Or you could > > preemptively fix any existing warnings in your doc builds before the > > release, but it's simple enough to turn off the feature if there isn't > > time. > > Thanks a lot for the heads-up. I pushed the following patch for neutron: > https://review.openstack.org/332145 > > I don’t fix warnings that may be currently in the tree. I will do it once we > have a new pbr release: even if I would fix warnings we may have now, it > wouldn’t give any guarantee to us that nothing would sneak into the tree > after my fix. So I prefer just wait for new pbr and then fix it all in one go. > > Ihar
That approach makes sense. Doug __________________________________________________________________________ OpenStack Development Mailing List (not for usage questions) Unsubscribe: [email protected]?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
