[openstack-dev] [docs][neutron] checking link integrity in the gate

Doug Hellmann doug at doughellmann.com
Tue Sep 5 17:53:40 UTC 2017

Excerpts from Boden Russell's message of 2017-09-05 11:25:34 -0600:
> On 9/5/17 11:03 AM, Doug Hellmann wrote:
> > Is eventlet being initialized (or partially initialized) when a module
> > from the application is imported for the auto-generated API
> > documentation?
> More than likely :)
> But even if they are, what's the fix/workaround?

Ensure that it is fully initialized, or not initialized at all, I would
think. I'm sure Sphinx does not expect to be running under eventlet.

I see a comment in neutron's doc/source/conf.py about another issue with
eventlet and some of the test code. I would start by configuring pbr to
ignore the test code when generating class documentation and see if that
eliminates both problems. See "autodoc_tree_excludes" in
https://docs.openstack.org/pbr/latest/user/using.html#pbr for details.

If that doesn't help, then I would try to find a way to avoid
initializing eventlet at all. For example, set an environment variable
in doc/source/conf.py and then look for it in
neutron/common/eventlet_utils.py and skip the call to

If neither of those options work, we can continue thinking of other


More information about the OpenStack-dev mailing list