Merge pull request #83 from seanpue/continue_linenos_setting

Continue linenos through setting

Author: akhmerov

doc/source/index.rst

@@ -193,7 +193,6 @@ produces:
     print('B')
     print('C')
 
-
 Controlling exceptions
 ----------------------
 
@@ -347,3 +346,11 @@ 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
+
+    Whether to show line numbering in all ``jupyter-execute`` sources.
+
+jupyter_sphinx_continue_linenos
+
+    Whether to show continuous line numbering in all ``jupyter-execute`` sources.

jupyter_sphinx/execute.py

@@ -135,7 +135,7 @@ class JupyterCell(Directive):
     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 numbers.
+        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
@@ -332,7 +332,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
@@ -399,11 +400,19 @@ def apply(self):
                 source = node.children[0]
                 source.attributes['language'] = lexer
 
-            # Add line numbers
+            # 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.
+            # Update current line numbers from cell if jupyter_sphinx_continue_linenos
+            # is set.
+            linenostart = 1
             for node in nodes:
-                if node["linenos"]:
-                    source = node.children[0]
+                source = node.children[0]
+                if linenos_config or continue_linenos or node["linenos"]:
                     source["linenos"] = True
+                if continue_linenos:
+                    source["highlight_args"] = {'linenostart': linenostart}
+                    linenostart += source.rawsource.count("\n") + 1
 
 
             # Add code cell CSS class
@@ -820,6 +829,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

@@ -141,6 +141,45 @@ def test_linenos(doctree):
     assert cell.attributes['linenos'] is True
 
 
+def test_linenos_conf_option(doctree):
+    source = '''
+    .. jupyter-execute::
+
+        2 + 2
+    '''
+    tree = doctree(source, config="jupyter_sphinx_linenos = True")
+    cell, = tree.traverse(JupyterCellNode)
+    assert cell.children[0].attributes['linenos']
+    assert 'highlight_args' not in cell.children[0].attributes
+    assert cell.children[0].rawsource.strip() == "2 + 2"
+    assert cell.children[1].rawsource.strip() == "4"
+
+
+def test_continue_linenos_conf_option(doctree):
+    source = '''
+    .. jupyter-execute::
+
+        2 + 2
+
+    .. jupyter-execute::
+
+        3 + 3
+
+    '''
+    continue_linenos_config = "jupyter_sphinx_continue_linenos = True"
+    tree = doctree(source, config=continue_linenos_config)
+    cell0, cell1 = tree.traverse(JupyterCellNode)
+    assert cell0.children[0].attributes['linenos']
+    assert cell0.children[0].attributes['highlight_args']['linenostart'] == 1
+    assert cell0.children[0].rawsource.strip() == "2 + 2"
+    assert cell0.children[1].rawsource.strip() == "4"
+
+    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"
+
+
 def test_execution_environment_carries_over(doctree):
     source = '''
     .. jupyter-execute::