Re: [dpdk-dev] [PATCH] doc: make sphinx errors more visible

[Thomas Monjalon <thomas@monjalon.net>]

16/10/2020 11:18, Bruce Richardson:
> On Fri, Oct 16, 2020 at 05:39:55AM +0200, Thomas Monjalon wrote:
> > When running Sphinx through ninja, the wrapper configured in meson
> > redirects stdout to a log file.
> > It makes more important to print issues on stderr.
> > 
> > Some warnings generated by the conf.py were hidden because
> > printed on stdout. The first improvement is to print them on stderr.
> > 
> > The second measure is to stop processing if meson was configured
> > with --werror.
> > 
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> > ---
> >  buildtools/call-sphinx-build.py |  3 +++
> >  doc/guides/conf.py              | 19 +++++++++++++++----
> >  2 files changed, 18 insertions(+), 4 deletions(-)
> > 
> > diff --git a/buildtools/call-sphinx-build.py b/buildtools/call-sphinx-build.py
> > index 26b199220a..8b266bec9b 100755
> > --- a/buildtools/call-sphinx-build.py
> > +++ b/buildtools/call-sphinx-build.py
> > @@ -14,6 +14,9 @@
> >  
> >  # set the version in environment for sphinx to pick up
> >  os.environ['DPDK_VERSION'] = version
> > +# forward error policy to conf.py
> > +if '-W' in extra_args:
> > +    os.environ['SPHINX_STOP_ON_ERROR'] = 'true'
> >  
> 
> Actually, I'm not sure this is necessary. Since the conf.py is processed
> from within the sphinx process itself, you can access sys.argv directly
> from within conf.py, rather than having to pass variables through the
> environment.

Great idea, thanks