[ovs-dev] sphinx on os x on travis?

[Lance Richardson]

----- Original Message -----
> From: "Ben Pfaff" <blp at ovn.org>
> To: dev at openvswitch.org
> Cc: "Lance Richardson" <lrichard at redhat.com>
> Sent: Friday, March 17, 2017 7:09:51 PM
> Subject: sphinx on os x on travis?
> 
> I'm seeing failures on Travis that boil down to this:
> 
>     /home/travis/build/blp/ovs-reviews/Documentation/intro/install/documentation.rst:34:
>     ERROR: Error in "note" directive:
>     invalid option block.
> 
>     .. note::
>       These instructions provide information on building the documentation
>       locally.
>       For information on writing documentation, refer to
>       :doc:`/internals/contributing/documentation-style`
> 
> e.g. in https://travis-ci.org/blp/ovs-reviews/jobs/212266894.
> 
> Some web searches suggest this might be due to an old python-sphinx
> version.  Do anyone know how to make travis use a newer version?
> 
> Thanks,
> 
> Ben.
> 

Hi Ben,

After taking another look, it seems this has nothing to do with os x
(the same failure is occurring on Linux builds as well). These failures
appear to have started with this commit, which lowered the minimum
sphinx version to 1.1:

https://github.com/openvswitch/ovs/commit/59cf52e6d3307d5889335893fc941fe55cd3ed99

The failures (on both Linux and os x) are preceded by:

    Running Sphinx v1.1.3

Based on the above, I think the issue is that sphinx 1.1 isn't actually sufficient
to build the documentation.

   Lance