UTF-8 is now ubiquitous as the default encoding for text, and specifically Unicode. Were Sphinx to be designed today, we would simply expect all source files to be encoded in UTF-8. The default source encoding has been UTF-8 since 2008.
This is a tracking issue for deprecation, and eventual removal, of support for all source encodings other than UTF-8 in Sphinx. If this would cause a significant issue for you, please add a comment explaining your situation. We are open to change in the scheduled plan if there are more people affected than we're aware of.
A current GitHub search shows ~50 affected projects. None of the top 15,000 PyPI packages are affected.
If source_encoding is not set in conf.py, or it is set to any of utf-8, utf-8-sig, or utf8, your project will not be affected by this change.
Plan
- The next release of Sphinx will contain a warning if the source encoding is explicitly set and is not
utf-8, utf8, or utf-8-sig.
- Sphinx 10 will change this warning to an error.
- Sphinx 12 or later will remove the
source_encoding configuration variable.
A
UTF-8 is now ubiquitous as the default encoding for text, and specifically Unicode. Were Sphinx to be designed today, we would simply expect all source files to be encoded in UTF-8. The default source encoding has been UTF-8 since 2008.
This is a tracking issue for deprecation, and eventual removal, of support for all source encodings other than UTF-8 in Sphinx. If this would cause a significant issue for you, please add a comment explaining your situation. We are open to change in the scheduled plan if there are more people affected than we're aware of.
A current GitHub search shows ~50 affected projects. None of the top 15,000 PyPI packages are affected.
If
source_encodingis not set inconf.py, or it is set to any ofutf-8,utf-8-sig, orutf8, your project will not be affected by this change.Plan
utf-8,utf8, orutf-8-sig.source_encodingconfiguration variable.A