summaryrefslogtreecommitdiffstats
path: root/Doc/tools
diff options
context:
space:
mode:
authorAdam Turner <9087854+AA-Turner@users.noreply.github.com>2024-07-23 12:30:06 (GMT)
committerGitHub <noreply@github.com>2024-07-23 12:30:06 (GMT)
commit53e9e7de6359845f118431c05e2f14a96e03b757 (patch)
tree8435727ce773e096018c60644ad22c6fabb992c3 /Doc/tools
parent1bcc9eb8623c4e9bd8460f22b5ebae4e0cb434e4 (diff)
downloadcpython-53e9e7de6359845f118431c05e2f14a96e03b757.zip
cpython-53e9e7de6359845f118431c05e2f14a96e03b757.tar.gz
cpython-53e9e7de6359845f118431c05e2f14a96e03b757.tar.bz2
GH-121970: Remove ``escape4chm`` (#122065)
Diffstat (limited to 'Doc/tools')
-rw-r--r--Doc/tools/extensions/escape4chm.py58
1 files changed, 0 insertions, 58 deletions
diff --git a/Doc/tools/extensions/escape4chm.py b/Doc/tools/extensions/escape4chm.py
deleted file mode 100644
index 8997097..0000000
--- a/Doc/tools/extensions/escape4chm.py
+++ /dev/null
@@ -1,58 +0,0 @@
-"""
-Escape the `body` part of .chm source file to 7-bit ASCII, to fix visual
-effect on some MBCS Windows systems.
-
-https://bugs.python.org/issue32174
-"""
-
-import pathlib
-import re
-from html.entities import codepoint2name
-
-from sphinx.util.logging import getLogger
-
-# escape the characters which codepoint > 0x7F
-def _process(string):
- def escape(matchobj):
- codepoint = ord(matchobj.group(0))
-
- name = codepoint2name.get(codepoint)
- if name is None:
- return '&#%d;' % codepoint
- else:
- return '&%s;' % name
-
- return re.sub(r'[^\x00-\x7F]', escape, string)
-
-def escape_for_chm(app, pagename, templatename, context, doctree):
- # only works for .chm output
- if getattr(app.builder, 'name', '') != 'htmlhelp':
- return
-
- # escape the `body` part to 7-bit ASCII
- body = context.get('body')
- if body is not None:
- context['body'] = _process(body)
-
-def fixup_keywords(app, exception):
- # only works for .chm output
- if getattr(app.builder, 'name', '') != 'htmlhelp' or exception:
- return
-
- getLogger(__name__).info('fixing HTML escapes in keywords file...')
- outdir = pathlib.Path(app.builder.outdir)
- outname = app.builder.config.htmlhelp_basename
- with open(outdir / (outname + '.hhk'), 'rb') as f:
- index = f.read()
- with open(outdir / (outname + '.hhk'), 'wb') as f:
- f.write(index.replace(b'&#x27;', b'&#39;'))
-
-def setup(app):
- # `html-page-context` event emitted when the HTML builder has
- # created a context dictionary to render a template with.
- app.connect('html-page-context', escape_for_chm)
- # `build-finished` event emitted when all the files have been
- # output.
- app.connect('build-finished', fixup_keywords)
-
- return {'version': '1.0', 'parallel_read_safe': True}