From 8943d29b857abb30b0298171525e20585d03fd6b Mon Sep 17 00:00:00 2001 From: Phillip Shiu Date: Thu, 9 Jun 2022 09:59:27 -0400 Subject: [PATCH] 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 https://github.com/sphinx-doc/sphinx/issues/10474. --- cookiecutter-django-app/{{cookiecutter.repo_name}}/docs/conf.py | 2 +- .../{{cookiecutter.placeholder_repo_name}}/docs/conf.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/cookiecutter-django-app/{{cookiecutter.repo_name}}/docs/conf.py b/cookiecutter-django-app/{{cookiecutter.repo_name}}/docs/conf.py index 1b816d4a..d0df9469 100644 --- 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 index 3262a203..c6e63b0b 100644 --- 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: