Merge pull request #28093 from rjmccall/monkeyless-sphinx

Tell Sphinx about the Swift lexers without monkey-patching it

Author: rjmccall

docs/conf.py

@@ -13,6 +13,7 @@
 
 import sys
 from datetime import date
+from sphinx.highlighting import lexers
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -263,9 +264,7 @@
 # Enable this if you want TODOs to show up in the generated documentation.
 todo_include_todos = True
 
-#
-# Monkeypatch pygments so it will know about the Swift lexers
-#
+# -- Patch pygments so it will know about the Swift lexers ---------------
 
 # Pull in the Swift lexers
 from os.path import abspath, dirname, join as join_paths  # noqa (E402)
@@ -277,22 +276,6 @@
 
 sys.path.pop(0)
 
-# Monkeypatch pygments.lexers.get_lexer_by_name to return our lexers. The
-# ordering required to allow for monkeypatching causes the warning
-# "I100 Import statements are in the wrong order." when linting using
-# flake8-import-order. "noqa" is used to suppress this warning.
-from pygments.lexers import get_lexer_by_name as original_get_lexer_by_name  # noqa (E402)
-
-
-def swift_get_lexer_by_name(_alias, *args, **kw):
-    if _alias == 'swift':
-        return swift_pygments_lexers.SwiftLexer()
-    elif _alias == 'sil':
-        return swift_pygments_lexers.SILLexer()
-    elif _alias == 'swift-console':
-        return swift_pygments_lexers.SwiftConsoleLexer()
-    else:
-        return original_get_lexer_by_name(_alias, *args, **kw)
-
-import pygments.lexers  # noqa (I100 Import statements are in the wrong order.)
-pygments.lexers.get_lexer_by_name = swift_get_lexer_by_name
+lexers['swift'] = swift_pygments_lexers.SwiftLexer()
+lexers['sil'] = swift_pygments_lexers.SILLexer()
+lexers['swift-console'] = swift_pygments_lexers.SwiftConsoleLexer()