sphinx: change default language to 'en'

[PATCH] sphinx: change default language to 'en'

Posted by Martin Liška 1 year, 11 months ago

Fixes the following Sphinx warning (treated as error) starting
with 5.0 release:

Warning, treated as error:
Invalid configuration value found: 'language = None'. Update your configuration to a valid langauge code. Falling back to 'en' (English).

Signed-off-by: Martin Liska <mliska@suse.cz>
---
 docs/conf.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/conf.py b/docs/conf.py
index 49dab44cca..e33cf3d381 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -126,7 +126,7 @@
 #
 # 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

Re: [PATCH] sphinx: change default language to 'en'

Posted by Peter Maydell 1 year, 11 months ago

On Fri, 17 Jun 2022 at 15:02, Martin Liška <mliska@suse.cz> wrote:
>
> Fixes the following Sphinx warning (treated as error) starting
> with 5.0 release:
>
> Warning, treated as error:
> Invalid configuration value found: 'language = None'. Update your configuration to a valid langauge code. Falling back to 'en' (English).

(The typo here ("langauge") is present in the upstream Sphinx error message.)

Reviewed-by: Peter Maydell <peter.maydell@linaro.org>

and applied to target-arm.next; thanks.

(I also checked that this didn't break any of the older sphinx
versions we need to continue supporting.)

-- PMM

Re: [PATCH] sphinx: change default language to 'en'

Posted by Martin Liška 1 year, 11 months ago

On 6/20/22 16:15, Peter Maydell wrote:
> On Fri, 17 Jun 2022 at 15:02, Martin Liška <mliska@suse.cz> wrote:
>>
>> Fixes the following Sphinx warning (treated as error) starting
>> with 5.0 release:
>>
>> Warning, treated as error:
>> Invalid configuration value found: 'language = None'. Update your configuration to a valid langauge code. Falling back to 'en' (English).
> 
> (The typo here ("langauge") is present in the upstream Sphinx error message.)

Yep, it's very funny :) Anyway, they fixed that in latest Sphinx release.

> 
> Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
> 
> and applied to target-arm.next; thanks.
> 
> (I also checked that this didn't break any of the older sphinx
> versions we need to continue supporting.)
> 
> -- PMM