[libcamera-devel] [PATCH] Documentation: Use language 'en' for Sphinx 5.0.0

[Jacopo Mondi]

Hi Kieran

On Mon, Jun 20, 2022 at 04:54:34PM +0100, Kieran Bingham wrote:
> Quoting Jacopo Mondi via libcamera-devel (2022-06-20 13:55:07)
> > Recent versions of Sphinx (> 5.0.0) have dropped support for the
> > 'None' keyword as language specifier:
> >
> > https://www.sphinx-doc.org/en/master/changes.html#release-5-0-0-released-may-30-2022
> >
> > 10474: language does not accept None as it value. The default value of
> >        language becomes to 'en' now. Patch by Adam Turner and Takeshi
> >        KOMIYA.
> >
> > Causing a compile time warning:
> >
> > WARNING: Invalid configuration value found: 'language = None'.
> > Update your configuration to a valid language code. Falling
> > back to 'en' (English).
> >
> > Change the language setting to 'en' to silence the warning.
>
> Well, I think falling back to English is probably useful ;-)
>

It is, but it triggers a warning and -Werror causes the build to fail

>
> Reviewed-by: Kieran Bingham <kieran.bingham at ideasonboard.com>
>
> >
> > Signed-off-by: Jacopo Mondi <jacopo at jmondi.org>
> > ---
> >  Documentation/conf.py | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/Documentation/conf.py b/Documentation/conf.py
> > index 78602c85e33f..7eeea7f3865b 100644
> > --- a/Documentation/conf.py
> > +++ b/Documentation/conf.py
> > @@ -56,7 +56,7 @@ master_doc = 'index'
> >  #
> >  # This is also used if you do content translation via gettext catalogs.
> >  # Usually you set "language" from the command line for these cases.
> > -language = None
> > +language = 'en'
> >
> >  # List of patterns, relative to source directory, that match files and
> >  # directories to ignore when looking for source files.
> > --
> > 2.36.1
> >