[Python-checkins] gh-91207: Fix CSS bug in Windows CHM help file and add deprecation message (GH-95607)

zooba webhook-mailer at python.org
Wed Aug 3 15:23:32 EDT 2022


https://github.com/python/cpython/commit/ac3bf6155f8addc62f9a9c48f07eef8c3a6f71b2
commit: ac3bf6155f8addc62f9a9c48f07eef8c3a6f71b2
branch: main
author: CAM Gerlach <CAM.Gerlach at Gerlach.CAM>
committer: zooba <steve.dower at microsoft.com>
date: 2022-08-03T20:23:20+01:00
summary:

gh-91207: Fix CSS bug in Windows CHM help file and add deprecation message (GH-95607)

files:
A Misc/NEWS.d/next/Documentation/2022-08-03-13-35-08.gh-issue-91207.eJ4pPf.rst
M Doc/conf.py

diff --git a/Doc/conf.py b/Doc/conf.py
index bf0af6a663c..0a436d7affc 100644
--- a/Doc/conf.py
+++ b/Doc/conf.py
@@ -79,6 +79,13 @@
     'root_include_title': False   # We use the version switcher instead.
 }
 
+# Override stylesheet fingerprinting for Windows CHM htmlhelp to fix GH-91207
+# https://github.com/python/cpython/issues/91207
+if any('htmlhelp' in arg for arg in sys.argv):
+    html_style = 'pydoctheme.css'
+    print("\nWARNING: Windows CHM Help is no longer supported.")
+    print("It may be removed in the future\n")
+
 # Short title used e.g. for <title> HTML tags.
 html_short_title = '%s Documentation' % release
 
diff --git a/Misc/NEWS.d/next/Documentation/2022-08-03-13-35-08.gh-issue-91207.eJ4pPf.rst b/Misc/NEWS.d/next/Documentation/2022-08-03-13-35-08.gh-issue-91207.eJ4pPf.rst
new file mode 100644
index 00000000000..8c7391f7edf
--- /dev/null
+++ b/Misc/NEWS.d/next/Documentation/2022-08-03-13-35-08.gh-issue-91207.eJ4pPf.rst
@@ -0,0 +1,3 @@
+Fix stylesheet not working in Windows CHM htmlhelp docs
+and add warning that they are deprecated.
+Contributed by C.A.M. Gerlach.



More information about the Python-checkins mailing list