From 9fc01a7efe8a058a4cbd5d5d2362eefd768a1699 Mon Sep 17 00:00:00 2001
From: Joseph Weston <joseph@weston.cloud>
Date: Thu, 25 Apr 2019 15:41:23 +0200
Subject: [PATCH] add jupyter-sphinx to documentation config
---
.gitlab-ci.yml | 4 ++--
doc/source/conf.py | 14 ++++++++++----
2 files changed, 12 insertions(+), 6 deletions(-)
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 326cf3e3..a063a879 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -241,7 +241,7 @@ build documentation:
script:
- pip install git+https://github.com/jupyter-widgets/jupyter-sphinx
- python -m ipykernel install --user --name kwant-latest
- - make -C doc realclean; make -C doc html SPHINXOPTS='-A website_deploy=True -n -W' SOURCE_LINK_TEMPLATE="$CI_PROJECT_URL"/blob/\$\$r/\$\$f
+ - make -C doc realclean; make -C doc html SPHINXOPTS='-A website_deploy=True -n -W -D jupyter_execute_default_kernel=kwant-latest' SOURCE_LINK_TEMPLATE="$CI_PROJECT_URL"/blob/\$\$r/\$\$f
artifacts:
paths:
- doc/build/html/
@@ -255,7 +255,7 @@ build PDF documentation:
script:
- pip install git+https://github.com/jupyter-widgets/jupyter-sphinx
- python -m ipykernel install --user --name kwant-latest
- - make -C doc latex SPHINXOPTS='-n -W'
+ - make -C doc latex SPHINXOPTS='-n -W -D jupyter_execute_default_kernel=kwant-latest'
- cd doc/build/latex
- make all-pdf
artifacts:
diff --git a/doc/source/conf.py b/doc/source/conf.py
index d3d7fceb..da68f06b 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -15,8 +15,15 @@ import sys
import os
import string
from distutils.util import get_platform
-sys.path.insert(0, "../../build/lib.{0}-{1}.{2}".format(
- get_platform(), *sys.version_info[:2]))
+
+package_path = os.path.abspath(
+ "../../build/lib.{0}-{1}.{2}"
+ .format(get_platform(), *sys.version_info[:2]))
+
+# Insert into sys.path so that we can import kwant here
+sys.path.insert(0, package_path)
+# Insert into PYTHONPATH so that jupyter-sphinx will pick it up
+os.environ['PYTHONPATH'] = ':'.join((package_path, os.environ.get('PYTHONPATH','')))
import kwant
import kwant.qsymm
@@ -31,7 +38,7 @@ sys.path.insert(0, os.path.abspath('../sphinxext'))
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.autosummary',
'sphinx.ext.todo', 'sphinx.ext.mathjax', 'numpydoc',
- 'kwantdoc', 'sphinx.ext.linkcode']
+ 'kwantdoc', 'sphinx.ext.linkcode', 'jupyter_sphinx.execute']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['../templates']
@@ -239,7 +246,6 @@ autosummary_generate = True
autoclass_content = "both"
autodoc_default_flags = ['show-inheritance']
-
# -- Teach Sphinx to document bound methods like functions ---------------------
import types
from sphinx.ext import autodoc
--
GitLab