fix: set sphinx language to 'en'

sphinx-quickstart previously generated `language = None` by default. As of Sphinx version 5, language will default to en. This squashes warnings when making the documentation like: Invalid configuration value found: 'language = None'. Update your configuration to a valid langauge code. Falling back to 'en' (English). For proof this is happening, see note on https://github.com/sphinx-doc/sphinx/blob/e1bf4dd5d5860a4c3790f41c5f5fe389dc5b4cf9/sphinx/config.py#L167-L174. For context on why this is happening, see sphinx-doc/sphinx#10474.
openedx · Jun 9, 2022 · 8943d29 · 8943d29
1 parent 34cd001
commit 8943d29
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/cookiecutter-django-app/{{cookiecutter.repo_name}}/docs/conf.py b/cookiecutter-django-app/{{cookiecutter.repo_name}}/docs/conf.py
@@ -109,7 +109,7 @@ def get_version(*file_paths):
 #
 # 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'
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:

diff --git a/python-template/{{cookiecutter.placeholder_repo_name}}/docs/conf.py b/python-template/{{cookiecutter.placeholder_repo_name}}/docs/conf.py
@@ -119,7 +119,7 @@ def get_version(*file_paths):
 #
 # 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'
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used: