Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

docs: adds to build_docs.py an encoding check suitable for windows

Browse source
This commit is contained in:
Andrei Gramakov 2020-07-17 13:29:34 +02:00
parent 7dfe4b4684
commit 010a825f48
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/build_docs.py
View file

@ -69,9 +69,13 @@ def main():
# functions and this way makes Python 2 compatibility really tough if there is any code that assumes text files contain strings (kconfiglib assumes this). # functions and this way makes Python 2 compatibility really tough if there is any code that assumes text files contain strings (kconfiglib assumes this).
# The reason for that is that you need to import io.open() to support the encoding argument on Python 2, and this function always uses Py2's unicode # The reason for that is that you need to import io.open() to support the encoding argument on Python 2, and this function always uses Py2's unicode
# type not the str type. # type not the str type.
if 'UTF-8' not in locale.getlocale(): if ('UTF-8' not in locale.getlocale()) and ('utf8' not in locale.getlocale()):
raise RuntimeError("build_docs.py requires the default locale's encoding to be UTF-8. " + raise RuntimeError("build_docs.py requires the default locale's encoding to be UTF-8.\n" +
"Setting environment variable LC_ALL=C.UTF-8 when running build_docs.py may be enough to fix this.") " - Linux. Setting environment variable LC_ALL=C.UTF-8 when running build_docs.py may be " +
"enough to fix this.\n"
" - Windows. Possible solution for the Windows 10 starting version 1803. Go to " +
"Control Panel->Clock and Region->Region->Administrative->Change system locale...; " +
"Check `Beta: Use Unicode UTF-8 for worldwide language support` and reboot")
parser = argparse.ArgumentParser(description='build_docs.py: Build IDF docs', prog='build_docs.py') parser = argparse.ArgumentParser(description='build_docs.py: Build IDF docs', prog='build_docs.py')