starlingx/kernel
Code Issues Proposed changes

doc: Fix Zuul/tox failures

Browse Source 
This commit resolves the Zuul/tox failures encountered when running
sphinx to generate documentation, which in turn prevents merging changes
that are otherwise fine:

```
docs: 350 W commands[1]> sphinx-build -a -E -W -d doc/build/doctrees \
  -b html doc/source doc/build/html [tox/tox_env/api.py:427]
Running Sphinx v6.2.1

Warning, treated as error:
Invalid configuration value found: 'language = None'. Update your \
  configuration to a valid language code. Falling back to 'en' \
  (English).
docs: 723 C exit 2 (0.37 seconds) \
    /home/zuul/src/opendev.org/starlingx/kernel> \
    sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source \
    doc/build/html pid=1720 [tox/execute/api.py:279]
  docs: FAIL code 2 (0.44=setup[0.07]+cmd[0.00,0.37] seconds)
  evaluation failed :( (0.54 seconds)
```

This issue was fixed for another StarlingX repository (tools) with
  https://review.opendev.org/c/starlingx/tools/+/893165
from which this commit is inspired.

The issue is related to a Sphinx update that requires the language
parameter to be specified:
  https://github.com/sphinx-doc/sphinx/issues/10062
  https://github.com/sphinx-doc/sphinx/issues/10474

Partial-Bug: 1976377
Partial-Bug: 2033431

Change-Id: Ic20fec5145b1a4ddb12051f018614562a4773b95
Signed-off-by: M. Vefa Bicakci <vefa.bicakci@windriver.com>
This commit is contained in:
M. Vefa Bicakci 2023-08-31 01:29:57 +00:00
parent b541465cc3
commit 5a1dfa8274
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/conf.py
View File

@ -62,7 +62,7 @@ openstackdocs_auto_name = False
# #
# This is also used if you do content translation via gettext catalogs. # This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases. # 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 # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # directories to ignore when looking for source files.