From 1ae66d079272518dd844e1fade291f52e8ab7579 Mon Sep 17 00:00:00 2001 From: Paul Wise Origin: https://github.com/mcfletch/pydispatcher/pull/3 Date: Sun, 22 Jan 2023 15:24:11 +0800 Subject: [PATCH] Handle changes to pydoc.HTMLDoc heading/section arguments in Python 3.11 This fixes a documentation build failure with Python 3.11, because the heading/section colours are now set via CSS and so the colour arguments no longer exist. Also the section cls argument was introduced in Python 3.11, create that based on slugifying the title argument. Fixes: https://bugs.debian.org/1028697 --- docs/pydoc/pydoc2.py | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) --- a/docs/pydoc/pydoc2.py +++ b/docs/pydoc/pydoc2.py @@ -4,6 +4,26 @@ class DefaultFormatter(pydoc.HTMLDoc): + def heading(self, *args): + try: + return super().heading(*args) + except TypeError: + # Python 3.11 doesn't use the color args + args = list(args) + del args[1:3] + return super().heading(*args) + + def section(self, *args): + try: + # Python 3.11 uses a class instead of colors + py311_args = list(args) + del py311_args[1:3] + cls = '-'.join(['section', *(args[0].lower().split())]) + py311_args.insert(1, cls) + return super().section(*py311_args) + except TypeError: + return super().section(*args) + def docmodule(self, object, name=None, mod=None, packageContext = None, *ignored): """Produce HTML documentation for a module object.""" name = object.__name__ # ignore the passed-in name