[openstack-dev] [all] Doc dependencies

Kevin L. Mitchell kevin.mitchell at rackspace.com
Fri Oct 2 15:20:49 UTC 2015

On Fri, 2015-10-02 at 11:00 -0400, Sean Dague wrote:
> On 10/02/2015 10:53 AM, Kevin L. Mitchell wrote:
> > The Pillow-breaking-gate issue was related to having doc dependencies
> > listed in the test-requirements.txt; however, those dependencies are not
> > needed for testing, except for doc testing and generation.  What do
> > people think about creating a new "doc-requirements.txt" file that would
> > contain only the doc dependencies?  The appropriate doc environments in
> > tox.ini would then need to be extended to pull in that file, and of
> > course the global requirements tooling would have to be enhanced to
> > recognize the new file as well.
> It would still have broken the gate, we test if docs build on every commit.

Yes—this is why I characterized it as "related"—but the test failure
would have at least been isolated to the docs test.  That would have
allowed reviews to get useful test results, instead of having a
dependency installation issue.  It's ultimately just a thought; it feels
wrong for us to install dependencies not directly related to testing,
even if we also test the doc generation.

> I think the bigger question is if we believe that a c compiler should be
> required to build docs on a python project. Which seems really weird to
> me. And a substantially higher barrier to entry than I think we want for
> docs contributions.

Well, Pillow isn't the only transitive dependency that's going to
require a C compiler; there are many other dependencies we have that are
actually extensions.

> There was only 1 use of this in all of Nova, and I think we're better
> off removing it and coming up with other ways of addressing it.

Perhaps, but having diagrams in the documentation is still going to be
incredibly useful, and Nova isn't the only component we have to consider
(which is why I removed the [nova] tag from the subject line).  That
said, I have no objection if we find or create a tool that generates
images without depending on Pillow, but…*shrug*
Kevin L. Mitchell <kevin.mitchell at rackspace.com>

More information about the OpenStack-dev mailing list