> From: "Ilya Maximets" <i.maxim...@samsung.com> > To: ovs-dev@openvswitch.org, "Lance Richardson" <lrich...@redhat.com>, "Ben > Pfaff" <b...@ovn.org> > Sent: Monday, March 20, 2017 2:54:55 AM > Subject: [ovs-dev] sphinx on os x on travis? > > Hi Ben and Lance, > > > Based on the above, I think the issue is that sphinx 1.1 isn't actually > > sufficient > > to build the documentation. > > That is not true. > Sphinx 1.1 has a minimum requirement of docutils 0.7 while sphinx 1.5 has a minimum requirement of docutils 0.11. Allowing doc builds with sphinx 1.1 means allowing doc builds with sphinx 1.1 + docutils 0.8, which is not sufficient to build the documentation in its current state.
> I made some investigation and found that root cause of this issue > is the version of python-docutils library. > > Described issue is a know bug of python-docutils library that was > introduced in version 0.8 and fixed in 0.9 [1]. > This library is used by sphinx for rST parsing. > > Bug in their bugtracker: https://sourceforge.net/p/docutils/bugs/182/ > > Travis uses Ubuntu 12.04 LTS for testing, but it contains[2] buggy > python-docutils (0.8.1-4ubuntu1). It's too old. > > Possible solutions to make Travis happy: > > * Update python-docutils to at least version 0.9 > This sounds like the best approach, however support for docutils 0.12 is listed as a "feature" for sphinx 1.3b1, so the version requirement might not be as simple as that. > * Use a workaround for buggy docutils like one > suggested in bugtracker: > > Always use a blank line before the content, i.e. > """ > .. note:: > > Some text > """ > instead of > """ > .. note:: > Some text > """ > I think this will make it easier for folks to accidentally break builds. > Looks like there was no documentation builds at all before > lowering the minimal sphinx version, because Ubuntu 12.04 > contains sphinx-1.1.3. > > My RHEL7 installation has python-sphinx-1.1.3 and python-docutils-0.11 > with no build issues. > > [1] http://docutils.sourceforge.net/HISTORY.html > [2] http://packages.ubuntu.com/precise/python-docutils > > Best regards, Ilya Maximets. > _______________________________________________ dev mailing list d...@openvswitch.org https://mail.openvswitch.org/mailman/listinfo/ovs-dev
