Merge branch 'doc/pdf-build' into 'stable'

enable PDF documentation builds

See merge request !171

.gitlab-ci.yml

@@ -63,6 +63,17 @@ build documentation:
       - doc/build/html/
     expire_in: 1 month
 
+build PDF documentation:
+  stage: test
+  script:
+    - pip3 install sympy
+    - make -C doc latex SPHINXOPTS='-n -W'
+    - cd doc/build/latex
+    - make all-pdf
+  artifacts:
+    paths:
+      - doc/build/latex/kwant.pdf
+    expire_in: 1 month
 
 run tests:
   stage: test

doc/Makefile

@@ -127,7 +127,7 @@ doctest:
 	      "results in $(BUILDDIR)/doctest/output.txt."
 
 %.pdf: %.svg
-	rsvg-convert -f pdf -o $@ $<
+	inkscape --export-pdf=$@ $<
 
 # Make tutorial scripts by extracting the (complete!) context of the "patches".
 # We make sure not to use 'wiggle' here.

doc/source/conf.py

@@ -199,6 +199,8 @@ r"""\makeatletter
 \newcommand{\braket}[2]{\left\langle#1|#2\right\rangle}
 \newcommand{\ri}{\text{i}}
 \newcommand{\rd}{\text{d}}
+
+\usepackage{unicode-math}
 """}
 
 # Grouping the document tree into LaTeX files. List of tuples
@@ -210,6 +212,8 @@ latex_documents = [
    'manual'),
 ]
 
+latex_engine = 'xelatex'
+
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
 #latex_logo = None

doc/source/tutorial/discretize.rst

@@ -219,7 +219,7 @@ and its discretized approximation
 
 
 where :math:`t=\frac{\hbar^2}{2ma^2}`, are only valid in the limit
-:math:`E \lt t`. The grid spacing :math:`a` must be chosen according
+:math:`E < t`. The grid spacing :math:`a` must be chosen according
 to how high in energy you need your tight-binding model to be valid.
 
 It is possible to set :math:`a` through the ``grid_spacing`` parameter

doc/source/tutorial/operators.rst

@@ -34,12 +34,12 @@ that, on site :math:`i`, points in the direction of the unit vector
 We shall take the following form for :math:`\mathbf{m}_i`:
 
 .. math::
-    \mathbf{m}_i &=&\ \left(
+    \mathbf{m}_i &=\ \left(
         \frac{x_i}{x_i^2 + y_i^2} \sin θ_i,\
         \frac{y_i}{x_i^2 + y_i^2} \sin θ_i,\
         \cos θ_i \right)^T,
     \\
-    θ_i &=&\ \frac{π}{2} (\tanh \frac{r_i - r_0}{δ} - 1),
+    θ_i &=\ \frac{π}{2} (\tanh \frac{r_i - r_0}{δ} - 1),
 
 where :math:`x_i` and :math:`y_i` are the :math:`x` and :math:`y` coordinates
 of site :math:`i`, and :math:`r_i = \sqrt{x_i^2 + y_i^2}`.