Notes.md

All Versions

• If you get an error during documentation build saying that itircl.dll was not registered correctly, go to externals\windows-installer\htmlhelp and run regsvr32 itcc.dll. Or you can install HTML Help Compiler system-wide, which would register this DLL anyway.
• Build from a path that doesn't contain spaces. Otherwise you may get an error 9009 when executing gendef.

Python 3.5

• Install Windows 8.1 SDK and Visual Studio 2015 build tools.
• Install SVN with command line tools from https://tortoisesvn.net/downloads.html.
• Build of installer works with Sphinx 1.7.9 for Python 3.5.5 to 3.5.7 and Sphinx 1.8.5 for Python 3.5.8 to 3.5.10. Install Sphinx into a Python 3.6 venv and set SPHINXBUILD to the path to sphinx-build.exe.
• Apply build-full-installer-1.patch to include debug symbols and debug binaries in the installer.
• Run buildrelease.bat -x86 -x64.

Python 3.6

• Install Sphinx 1.8.5 to a Python 3.6 venv and set SPHINXBUILD to the path to sphinx-build.exe.
• Due to a bug in build scripts (https://bugs.python.org/issue35374), set HTMLHELP to the path to hhc.exe in externals\windows-installer\htmlhelp.
• Install Windows SDK 10.0.10586.212.
• Apply build-full-installer-1.patch to include debug symbols and debug binaries in the installer.
• Apply fix-test_winconsole.patch to fix a hang during PGO profile generation.
• Run buildrelease.bat -x86 -x64.

Python 3.7

• Install Sphinx 2.4.5 to a Python 3.6 venv and set PYTHON to the location of the Python executable.
• Apply build-full-installer-2.patch to include debug symbols and debug binaries in the installer.
• Apply fix-htmlhelp.patch to fix error in documentation build (https://bugs.python.org/issue46463).
• Apply fix-test_winconsole.patch to fix a hang during PGO profile generation.
• Run buildrelease.bat -x86 -x64.

Python 3.8

• Install Sphinx 2.4.5 to a Python 3.6 venv and set PYTHON to the location of the Python executable.
• Apply libffi-fix-1.patch for 3.8.11 or libffi-fix-2.patch for 3.8.12 to avoid error where libffi-7.lib can't be found.
• Apply build-full-installer-2.patch to include debug symbols and debug binaries in the installer.
• Apply fix-htmlhelp.patch to fix error in documentation build (https://bugs.python.org/issue46463).
• Apply fix-chm.patch to fix formatting errors in the .chm help file (https://bugs.python.org/issue47051).
• Run buildrelease.bat -x86 -x64.

Python 3.9

• Install Sphinx 3.5.4 to a Python 3.6 venv and set PYTHON to the location of the Python executable.
• Apply build-full-installer-3.patch to include debug symbols and debug binaries in the installer.
• Apply guid-fix.patch to work around python/cpython#96729.
• Apply fix-chm.patch to fix formatting errors in the .chm help file (https://bugs.python.org/issue47051).
• Run buildrelease.bat -x86 -x64.