From 9c1dcfcbd34e41e8699fbb0c2146d56ee8960a8d Mon Sep 17 00:00:00 2001
From: Yuvi Panda <yuvipanda@gmail.com>
Date: Fri, 3 Dec 2021 03:33:51 +0530
Subject: [PATCH] Allow passing extra args to code highlighter (#1683)

I primarily want to allow for the possibility of line numbers
in HTML output. Pygments supports this natively, but we don't
have a way to pass arguments through to pygments.

A traitlet is added to allow passing arbitrary extra args
to the Pygments formatter, for Html and LaTeX. Should allow for
line number control and much more :)

This has been something folks have asked for for a while.

Ref https://github.com/ipython/ipython/issues/5847
Ref https://github.com/jupyter/nbconvert/issues/427
Ref https://github.com/notebook-sharing-space/nbss/issues/34
---
 nbconvert/filters/highlight.py | 31 +++++++++++++++++++++++++++----
 1 file changed, 27 insertions(+), 4 deletions(-)

diff --git a/nbconvert/filters/highlight.py b/nbconvert/filters/highlight.py
index c761802db..ed7bb57dd 100644
--- a/nbconvert/filters/highlight.py
+++ b/nbconvert/filters/highlight.py
@@ -14,6 +14,7 @@
 from warnings import warn
 
 from traitlets import observe
+from traitlets.config import Dict
 
 MULTILINE_OUTPUTS = ['text', 'html', 'svg', 'latex', 'javascript', 'json']
 
@@ -23,10 +24,21 @@
 ]
 
 class Highlight2HTML(NbConvertBase):
+    extra_formatter_options = Dict(
+        {},
+        help="""
+        Extra set of options to control how code is highlighted.
+
+        Passed through to the pygments' HtmlFormatter class.
+        See available list in https://pygments.org/docs/formatters/#HtmlFormatter
+        """,
+        config=True
+    )
+
     def __init__(self, pygments_lexer=None, **kwargs):
         self.pygments_lexer = pygments_lexer or 'ipython3'
         super().__init__(**kwargs)
-    
+
     @observe('default_language')
     def _default_language_changed(self, change):
         warn('Setting default_language in config is deprecated as of 5.0, '
@@ -53,15 +65,26 @@ def __call__(self, source, language=None, metadata=None):
 
         return _pygments_highlight(source if len(source) > 0 else ' ',
                                    # needed to help post processors:
-                                   HtmlFormatter(cssclass=" highlight hl-"+language),
+                                   HtmlFormatter(cssclass=" highlight hl-" + language, **self.extra_formatter_options),
                                    language, metadata)
 
 
 class Highlight2Latex(NbConvertBase):
+    extra_formatter_options = Dict(
+        {},
+        help="""
+        Extra set of options to control how code is highlighted.
+
+        Passed through to the pygments' LatexFormatter class.
+        See available list in https://pygments.org/docs/formatters/#LatexFormatter
+        """,
+        config=True
+    )
+
     def __init__(self, pygments_lexer=None, **kwargs):
         self.pygments_lexer = pygments_lexer or 'ipython3'
         super().__init__(**kwargs)
-    
+
     @observe('default_language')
     def _default_language_changed(self, change):
         warn('Setting default_language in config is deprecated as of 5.0, '
@@ -87,7 +110,7 @@ def __call__(self, source, language=None, metadata=None, strip_verbatim=False):
         if not language:
             language=self.pygments_lexer
 
-        latex = _pygments_highlight(source, LatexFormatter(), language, metadata)
+        latex = _pygments_highlight(source, LatexFormatter(**self.extra_formatter_options), language, metadata)
         if strip_verbatim:
             latex = latex.replace(r'\begin{Verbatim}[commandchars=\\\{\}]' + '\n', '')
             return latex.replace('\n\\end{Verbatim}\n', '')