Merge branch 'fixup/jupyter-sphinx' into 'master'

use latest jupyter-sphinx and configure thebelab

Closes #306

See merge request kwant/kwant!308

doc/kwantdoctheme/static/kwantdoctheme.css

@@ -94,6 +94,10 @@ div.body pre {
     border: 1px solid #ac9;
 }
 
+div.body pre.CodeMirror-line {
+    border: unset;
+}
+
 div.body div.admonition, div.body div.impl-detail {
     border-radius: 3px;
 }

doc/source/conf.py

@@ -107,6 +107,15 @@ pygments_style = 'sphinx'
 # Do not show all class members automatically in the class documentation
 numpydoc_show_class_members = False
 
+# Jupyter Sphinx config
+
+jupyter_sphinx_thebelab_config = {
+    "binderOptions": {
+        "repo": "kwant-project/binder",
+        "ref": "master",
+    }
+}
+
 # -- Options for HTML output ---------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  Major themes that come with

doc/source/tutorial/discretize.rst

@@ -16,6 +16,12 @@ The `~kwant.continuum` sub-package aims to be a solution to this problem.
 It is a collection of tools for working with
 continuum models and for discretizing them into tight-binding models.
 
+.. seealso::
+    You can execute the code examples live in your browser by
+    activating thebelab:
+
+    .. thebe-button:: Activate Thebelab
+
 .. seealso::
     The complete source code of this tutorial can be found in
     :jupyter-download:script:`discretize`

doc/source/tutorial/faq.rst

@@ -5,6 +5,12 @@ questions that are discussed there.  The `Kwant paper
 <https://downloads.kwant-project.org/doc/kwant-paper.pdf>`_ also digs deeper
 into Kwant's structure.
 
+.. seealso::
+    You can execute the code examples live in your browser by
+    activating thebelab:
+
+    .. thebe-button:: Activate Thebelab
+
 .. jupyter-execute::
     :hide-code:
 

doc/source/tutorial/first_steps.rst

@@ -60,6 +60,12 @@ simplicity, we choose to work in such units that :math:`t = a = 1`.
 Transport through a quantum wire
 ................................
 
+.. seealso::
+    You can execute the code examples live in your browser by
+    activating thebelab:
+
+    .. thebe-button:: Activate Thebelab
+
 .. seealso::
     The complete source code of this example can be found in
     :jupyter-download:script:`quantum_wire`

doc/source/tutorial/graphene.rst

@@ -3,6 +3,12 @@
 Beyond square lattices: graphene
 --------------------------------
 
+.. seealso::
+    You can execute the code examples live in your browser by
+    activating thebelab:
+
+    .. thebe-button:: Activate Thebelab
+
 .. seealso::
     The complete source code of this example can be found in
     :jupyter-download:script:`graphene`

doc/source/tutorial/kpm.rst

@@ -15,6 +15,12 @@ expansion of the density of states. It can also be used to calculate the
 spectral density of arbitrary operators.  Kwant has an implementation of the
 KPM method `kwant.kpm`, that is based on the algorithms presented in Ref. [1]_.
 
+.. seealso::
+    You can execute the code examples live in your browser by
+    activating thebelab:
+
+    .. thebe-button:: Activate Thebelab
+
 .. seealso::
     The complete source code of this example can be found in
     :jupyter-download:script:`kernel_polynomial_method`

doc/source/tutorial/magnetic_field.rst

@@ -4,6 +4,12 @@ Adding magnetic field
 Computing Landau levels in a harmonic oscillator basis
 ......................................................
 
+.. seealso::
+    You can execute the code examples live in your browser by
+    activating thebelab:
+
+    .. thebe-button:: Activate Thebelab
+
 .. seealso::
     The complete source code of this example can be found in
     :jupyter-download:script:`landau-levels`

doc/source/tutorial/operators.rst

@@ -11,6 +11,12 @@ In this tutorial we will see how we can calculate more general quantities than
 simple densities by studying spin transport in a system with a magnetic
 texture.
 
+.. seealso::
+    You can execute the code examples live in your browser by
+    activating thebelab:
+
+    .. thebe-button:: Activate Thebelab
+
 .. seealso::
     The complete source code of this example can be found in
     :jupyter-download:script:`magnetic_texture`

doc/source/tutorial/plotting.rst

@@ -10,6 +10,12 @@ these options can be used to achieve various very different objectives.
 2D example: graphene quantum dot
 ................................
 
+.. seealso::
+    You can execute the code examples live in your browser by
+    activating thebelab:
+
+    .. thebe-button:: Activate Thebelab
+
 .. seealso::
     The complete source code of this example can be found in
     :jupyter-download:script:`plot_graphene`

doc/source/tutorial/spectrum.rst

@@ -4,6 +4,12 @@ Beyond transport: Band structure and closed systems
 Band structure calculations
 ...........................
 
+.. seealso::
+    You can execute the code examples live in your browser by
+    activating thebelab:
+
+    .. thebe-button:: Activate Thebelab
+
 .. seealso::
     The complete source code of this example can be found in
     :jupyter-download:script:`band_structure`

doc/source/tutorial/spin_potential_shape.rst

@@ -9,6 +9,12 @@ very simple examples of the previous section.
 Matrix structure of on-site and hopping elements
 ................................................
 
+.. seealso::
+    You can execute the code examples live in your browser by
+    activating thebelab:
+
+    .. thebe-button:: Activate Thebelab
+
 .. seealso::
     The complete source code of this example can be found in
     :jupyter-download:script:`spin_orbit`

doc/source/tutorial/superconductors.rst

 Superconductors: orbital degrees of freedom, conservation laws and symmetries
 -----------------------------------------------------------------------------
 
+.. seealso::
+    You can execute the code examples live in your browser by
+    activating thebelab:
+
+    .. thebe-button:: Activate Thebelab
+
 .. seealso::
     The complete source code of this example can be found in
     :jupyter-download:script:`superconductor`

docker/kwant-latest.yml

@@ -26,6 +26,6 @@ dependencies:
     - sphinx
     - numpydoc
     - requests
+    - jupyter_sphinx
     - pip:
         - sphinxcontrib-svg2pdfconverter
-        - git+https://github.com/jupyter-widgets/jupyter-sphinx