diff options
| author | Jonathan Corbet <corbet@lwn.net> | 2025-09-09 13:35:37 -0600 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2025-09-15 17:24:06 -0600 |
| commit | 00d95fcc4dee66dfb6980de6f2973b32f973a1eb (patch) | |
| tree | cd45b0e87b1021a6491504c60fe8c28c708f2f5d /Documentation/sphinx/maintainers_include.py | |
| parent | 944df7a31452f75bbc15b1e7215e1aacee8cd1b4 (diff) | |
docs: kdoc: handle the obsolescensce of docutils.ErrorString()
The ErrorString() and SafeString() docutils functions were helpers meant to
ease the handling of encodings during the Python 3 transition. There is no
real need for them after Python 3.6, and docutils 0.22 removes them,
breaking the docs build
Handle this by just injecting our own one-liner version of ErrorString(),
and removing the sole SafeString() call entirely.
Reported-by: Zhixu Liu <zhixu.liu@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <87ldmnv2pi.fsf@trenco.lwn.net>
Diffstat (limited to 'Documentation/sphinx/maintainers_include.py')
| -rwxr-xr-x | Documentation/sphinx/maintainers_include.py | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Documentation/sphinx/maintainers_include.py b/Documentation/sphinx/maintainers_include.py index d31cff867436..519ad18685b2 100755 --- a/Documentation/sphinx/maintainers_include.py +++ b/Documentation/sphinx/maintainers_include.py @@ -22,10 +22,12 @@ import re import os.path from docutils import statemachine -from docutils.utils.error_reporting import ErrorString from docutils.parsers.rst import Directive from docutils.parsers.rst.directives.misc import Include +def ErrorString(exc): # Shamelessly stolen from docutils + return f'{exc.__class__.__name}: {exc}' + __version__ = '1.0' def setup(app): |