Added jupyter_sphinx_linenos and jupyter_sphinx_continue_linenos configuration options

Author: seanpue

doc/source/index.rst

@@ -193,32 +193,6 @@ produces:
     print('B')
     print('C')
 
-You may also *continue line numbers* from the previous cell with ``:continue-linenos:``::
-
-  .. jupyter-execute::
-      :linenos:
-
-      print('A')
-
-  .. jupyter-execute::
-      :continue-linenos:
-
-      print('B')
-      print('C')
-
-produces:
-
-.. jupyter-execute::
-    :linenos:
-
-    print('A')
-
-.. jupyter-execute::
-    :continue-linenos:
-
-    print('B')
-    print('C')
-
 Controlling exceptions
 ----------------------
 
@@ -353,3 +327,14 @@ jupyter_execute_kwargs
 
     Keyword arguments to pass to ``nbconvert.preprocessors.execute.executenb``, which controls how
     code cells are executed. The default is ``dict(timeout=-1, allow_errors=True)``.
+
+jupyter_sphinx_linenos
+
+    Boolean argument it use line numbering in code cell display by default. Equivalent
+    to setting the `linenos` directive for all code cells.
+
+jupyter_sphinx_continue_linenos
+
+    Boolean argument to use line numbering in code cells and continue line numbering
+    from the previous cell. When set, line number can be reset to start at one by using
+    the directive `linenos`.

jupyter_sphinx/execute.py

@@ -131,6 +131,8 @@ class JupyterCell(Directive):
         If provided, the cell output will not be displayed in the output.
     code-below : bool
         If provided, the code will be shown below the cell output.
+    linenos : bool
+        If provided, the code will be shown with line numbering.
     raises : comma separated list of exception types
         If provided, a comma-separated list of exception type names that
         the cell may raise. If one of the listed execption types is raised
@@ -154,7 +156,7 @@ class JupyterCell(Directive):
         'hide-output': directives.flag,
         'code-below': directives.flag,
         'linenos': directives.flag,
-        'continue-linenos': directives.flag,
+        # 'continue-linenos': directives.flag,   #<--- remove this
         'raises': csv_option,
         'stderr': directives.flag,
     }
@@ -190,7 +192,7 @@ def run(self):
             hide_output=('hide-output' in self.options),
             code_below=('code-below' in self.options),
             linenos=('linenos' in self.options),
-            continue_linenos=('continue-linenos' in self.options),
+            # continue_linenos=('continue-linenos' in self.options),
             raises=self.options.get('raises'),
             stderr=('stderr' in self.options),
         )]
@@ -329,7 +331,8 @@ def apply(self):
         default_kernel = self.config.jupyter_execute_default_kernel
         default_names = default_notebook_names(docname)
         thebe_config = self.config.jupyter_sphinx_thebelab_config
-
+        linenos_config = self.config.jupyter_sphinx_linenos
+        continue_linenos = self.config.jupyter_sphinx_continue_linenos
         # Check if we have anything to execute.
         if not doctree.traverse(JupyterCellNode):
             return
@@ -396,23 +399,24 @@ def apply(self):
                 source = node.children[0]
                 source.attributes['language'] = lexer
 
-            # Add line numbers to code cells if linenos directive is set.
-            # Continue line numbers from previous cell with line numbers
-            # if continue-linenos directive is set.
+            # Add line numbers to code cells if jupyter_sphinx_linenos or
+            # jupyter_sphinx_continue_linenos are set in the configuration,
+            # or the linenos directive is set.
+            # Reset linenumber if linenos directive is set.
+            # Update current line numbers from cell if jupyter_sphinx_continue_linenos
+            # is set.
             linenostart = 1
             for node in nodes:
                 source = node.children[0]
-                if node["continue_linenos"]:
+                if linenos_config or continue_linenos:
                     source["linenos"] = True
-                    source["highlight_args"] = {'linenostart': linenostart}
-                elif node["linenos"]:
+                if node["linenos"]:
                     linenostart = 1
                     source["linenos"] = True
-                # Advance linenostart or reset it
-                if node["continue_linenos"] or node["linenos"]:
+                if continue_linenos:
+                    source["linenos"] = True
+                    source["highlight_args"] = {'linenostart': linenostart}
                     linenostart += source.rawsource.count("\n") + 1
-                else:
-                    linenostart = 1
 
             # Write certain cell outputs (e.g. images) to separate files, and
             # modify the metadata of the associated cells in 'notebook' to
@@ -791,6 +795,10 @@ def setup(app):
 
     app.add_config_value('jupyter_sphinx_thebelab_url', THEBELAB_URL_DEFAULT, 'html')
 
+    # linenos config
+    app.add_config_value('jupyter_sphinx_linenos', False, 'env')
+    app.add_config_value('jupyter_sphinx_continue_linenos', False, 'env')
+
     # Used for nodes that do not need to be rendered
     def skip(self, node):
         raise docutils.nodes.SkipNode

tests/test_execute.py

@@ -139,91 +139,91 @@ def test_linenos(doctree):
     cell, = tree.traverse(JupyterCellNode)
     assert len(cell.children) == 2
     assert cell.attributes['linenos'] is True
-
-
-def test_continue_linenos(doctree):
-    source = '''
-    .. jupyter-execute::
-        :linenos:
-
-        2 + 2
-
-    .. jupyter-execute::
-        :continue-linenos:
-
-        3 + 3
-    '''
-    tree = doctree(source)
-    (cell0, cell1) = tree.traverse(JupyterCellNode)
-    # :linenos:
-    assert cell0.attributes['linenos']
-    assert cell0.attributes['continue_linenos'] is False
-    assert cell0.children[0].attributes['linenos']
-    assert 'highlight_args' not in cell0.children[0].attributes
-    assert cell0.children[0].rawsource.strip() == "2 + 2"
-    assert cell0.children[1].rawsource.strip() == "4"
-    # :continue-linenos:
-    assert cell1.attributes['linenos'] is False
-    assert cell1.attributes['continue_linenos']
-    assert 'highlight_args' not in cell1.attributes
-    assert cell1.children[0].attributes['linenos']
-    assert cell1.children[0].attributes['highlight_args']['linenostart'] == 2
-    assert cell1.children[0].rawsource.strip() == "3 + 3"
-    assert cell1.children[1].rawsource.strip() == "6"
-
-    source2 = '''
-    .. jupyter-execute::
-        :linenos:
-
-        'cell0'  # will be line number 1
-
-    .. jupyter-execute::
-        :linenos:
-
-        'cell1'  # should restart with line number 1
-
-    .. jupyter-execute::
-        :continue-linenos:
-
-        'cell2'  # should be line number 2
-
-    .. jupyter-execute::
-
-        'cell3' # no line number directive
-
-    .. jupyter-execute::
-        :continue-linenos:
-
-        'cell4' # should restart at line number 1
-
-    .. jupyter-execute::
-        :continue-linenos:
-
-        'cell5' # should continue with line number 2
-    '''
-    tree2 = doctree(source2)
-    cells = tree2.traverse(JupyterCellNode)
-    assert len(cells) == 6
-    (cell0, cell1, cell2, cell3, cell4, cell5) = cells
-    # :linenos:
-    assert cell0.children[0].attributes["linenos"]
-    assert "highlight_args" not in cell0.children[0].attributes
-    # :linenos:
-    assert cell1.children[0].attributes["linenos"]
-    assert "highlight_args" not in cell1.children[0].attributes
-    # :continue-linenos:
-    assert cell2.children[0].attributes["linenos"]
-    assert cell2.children[0].attributes["highlight_args"]["linenostart"] == 2
-    # (No line number directive)
-    assert "linenos" not in cell3.children[0].attributes
-    assert "highlight_args" not in cell3.children[0].attributes
-    # :continue-linenos:
-    assert cell4.children[0].attributes["linenos"]
-    assert cell4.children[0].attributes["highlight_args"]["linenostart"] == 1
-    # :continue-linenos:
-    assert cell5.children[0].attributes["linenos"]
-    assert cell5.children[0].attributes["highlight_args"]["linenostart"] == 2
-
+#
+#
+# def test_continue_linenos(doctree):
+#     source = '''
+#     .. jupyter-execute::
+#         :linenos:
+#
+#         2 + 2
+#
+#     .. jupyter-execute::
+#         :continue-linenos:
+#
+#         3 + 3
+#     '''
+#     tree = doctree(source)
+#     (cell0, cell1) = tree.traverse(JupyterCellNode)
+#     # :linenos:
+#     assert cell0.attributes['linenos']
+#     assert cell0.attributes['continue_linenos'] is False
+#     assert cell0.children[0].attributes['linenos']
+#     assert 'highlight_args' not in cell0.children[0].attributes
+#     assert cell0.children[0].rawsource.strip() == "2 + 2"
+#     assert cell0.children[1].rawsource.strip() == "4"
+#     # :continue-linenos:
+#     assert cell1.attributes['linenos'] is False
+#     assert cell1.attributes['continue_linenos']
+#     assert 'highlight_args' not in cell1.attributes
+#     assert cell1.children[0].attributes['linenos']
+#     assert cell1.children[0].attributes['highlight_args']['linenostart'] == 2
+#     assert cell1.children[0].rawsource.strip() == "3 + 3"
+#     assert cell1.children[1].rawsource.strip() == "6"
+#
+#     source2 = '''
+#     .. jupyter-execute::
+#         :linenos:
+#
+#         'cell0'  # will be line number 1
+#
+#     .. jupyter-execute::
+#         :linenos:
+#
+#         'cell1'  # should restart with line number 1
+#
+#     .. jupyter-execute::
+#         :continue-linenos:
+#
+#         'cell2'  # should be line number 2
+#
+#     .. jupyter-execute::
+#
+#         'cell3' # no line number directive
+#
+#     .. jupyter-execute::
+#         :continue-linenos:
+#
+#         'cell4' # should restart at line number 1
+#
+#     .. jupyter-execute::
+#         :continue-linenos:
+#
+#         'cell5' # should continue with line number 2
+#     '''
+#     tree2 = doctree(source2)
+#     cells = tree2.traverse(JupyterCellNode)
+#     assert len(cells) == 6
+#     (cell0, cell1, cell2, cell3, cell4, cell5) = cells
+#     # :linenos:
+#     assert cell0.children[0].attributes["linenos"]
+#     assert "highlight_args" not in cell0.children[0].attributes
+#     # :linenos:
+#     assert cell1.children[0].attributes["linenos"]
+#     assert "highlight_args" not in cell1.children[0].attributes
+#     # :continue-linenos:
+#     assert cell2.children[0].attributes["linenos"]
+#     assert cell2.children[0].attributes["highlight_args"]["linenostart"] == 2
+#     # (No line number directive)
+#     assert "linenos" not in cell3.children[0].attributes
+#     assert "highlight_args" not in cell3.children[0].attributes
+#     # :continue-linenos:
+#     assert cell4.children[0].attributes["linenos"]
+#     assert cell4.children[0].attributes["highlight_args"]["linenostart"] == 1
+#     # :continue-linenos:
+#     assert cell5.children[0].attributes["linenos"]
+#     assert cell5.children[0].attributes["highlight_args"]["linenostart"] == 2
+#
 
 def test_execution_environment_carries_over(doctree):
     source = '''