On Tue, 2017-03-07 at 08:21 -0500, Russell Bryant wrote: > > > On Tue, Mar 7, 2017 at 5:31 AM, Stephen Finucane <[email protected]> > 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 <[email protected]> > > > Signed-off-by: Darrell Ball <[email protected]> > > > CC: Stephen Finucane <[email protected]> > > > > 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 <[email protected]> > > > > 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.
This sounds good to me - I'd have it done already only I wasn't sure if you'd want a tox file in a non-Python project :) I can draft that shortly if you're OK with it. I'd still like to update the documentation guide in any case, even if only to reference the tox option. Stephen PS: This also sounds like something that could be automatically tested. If only some folks were working on a tool to automatically test mailing list patches... https://speakerdeck.com/stephenfin/mailing-list-meet-ci _______________________________________________ dev mailing list [email protected] https://mail.openvswitch.org/mailman/listinfo/ovs-dev
