added continue_linenos directive, doc updates, and tests

Author: seanpue

doc/source/index.rst

@@ -193,6 +193,31 @@ 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
 ----------------------

jupyter_sphinx/execute.py

@@ -154,6 +154,7 @@ class JupyterCell(Directive):
         'hide-output': directives.flag,
         'code-below': directives.flag,
         'linenos': directives.flag,
+        'continue_linenos': directives.flag,
         'raises': csv_option,
         'stderr': directives.flag,
     }
@@ -189,6 +190,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),
             raises=self.options.get('raises'),
             stderr=('stderr' in self.options),
         )]
@@ -394,11 +396,23 @@ def apply(self):
                 source = node.children[0]
                 source.attributes['language'] = lexer
 
-            # Add line numbers
+            # 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.
+            linenostart = 1
             for node in nodes:
-                if node["linenos"]:
-                    source = node.children[0]
+                source = node.children[0]
+                if node["continue_linenos"]:
+                    source["linenos"] = True
+                    source["highlight_args"] = {'linenostart': linenostart}
+                elif node["linenos"]:
+                    linenostart = 1
                     source["linenos"] = True
+                # Advance linenostart or reset it
+                if node["continue_linenos"] or node["linenos"]:
+                    linenostart += len(source.rawsource.split("\n"))
+                else:
+                    linenostart = 1
 
             # Write certain cell outputs (e.g. images) to separate files, and
             # modify the metadata of the associated cells in 'notebook' to

tests/test_execute.py

@@ -141,6 +141,90 @@ def test_linenos(doctree):
     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_execution_environment_carries_over(doctree):
     source = '''
     .. jupyter-execute::