On Tue, Mar 7, 2017 at 5:31 AM, Stephen Finucane <step...@that.guru> wrote:
> On Thu, 2017-03-02 at 20:01 -0800, Darrell Ball wrote:
> > Some code-block directives are not understood using
> > Trusty (I was using 14.04.1 when the issue was found)
> > default package versions, which blocks the build.
> >
> > An error example:
> > writing output... [100%] topics/language-bindings
> > Warning, treated as error:
> > /home/dball/ovs/Documentation/topics/language-bindings.rst:39:
> > WARNING: Pygments lexer name u'shell' is not known
> >
> > 14.04.1 has Sphinx 1.2.2 and Pygments 1.6.
> >
> > I expect Trusty to still be widely used, so we
> > should be able to build ovs with it.
> >
> > requirements.rst indicates only:
> > sphinx>=1.2,<2.0
> > ovs_sphinx_theme>=1.0,<1.1
> >
> > Fixes: f150a8bafbf2 ("doc: Document various language bindings")
> > Suggested-by: Daniele Di Proietto <diproiet...@vmware.com>
> > Signed-off-by: Darrell Ball <dlu...@gmail.com>
> > CC: Stephen Finucane <step...@that.guru>
>
> This all looks fine to me. I'm not sure if 14.04 is a valid
> target still (for development at least), but these changes are small
> enough and the requirements *do* state 1.2 as the minimum. As such:
>
> Acked-by: Stephen Finucane <step...@that.guru>
>
> Could you also submit a modification to the documentation style guide
> as a follow up, noting the need to validate docs against the minimum
> supported version?
>
Maybe we should set up a tox environment that builds the docs using the
minimum supported version of sphinx. That would make it easy on everyone
to test.
--
Russell Bryant
_______________________________________________
dev mailing list
d...@openvswitch.org
https://mail.openvswitch.org/mailman/listinfo/ovs-dev
