From 1b0a95e02b48f2ebf94c4ed889b735bd8b1b5011 Mon Sep 17 00:00:00 2001
From: Astrid Muennich <astrid.muennich@xfel.eu>
Date: Wed, 22 Aug 2018 11:45:53 +0200
Subject: [PATCH] include tutorial notebook rendering rst in documentation

---
 docs/source/conf.py        | 11 +++++++++++
 docs/source/index.rst      |  1 +
 docs/source/makeAllDocs.sh | 37 +++++++++++++++++++++++++++++++++++++
 3 files changed, 49 insertions(+)
 create mode 100755 docs/source/makeAllDocs.sh

diff --git a/docs/source/conf.py b/docs/source/conf.py
index 2d12d2d83..e7504aad1 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -31,12 +31,22 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    'sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',
     'sphinx.ext.todo',
     'sphinx.ext.mathjax',
     'sphinx.ext.ifconfig',
+    'sphinx.ext.viewcode',
 ]
 
+import sys
+import os
+from subprocess import Popen
+
+sys.path.append(os.path.abspath("../pycalibration/"))
+p = Popen(["./makeAllDocs.sh"])
+p.communicate()
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
@@ -259,6 +269,7 @@ latex_elements = {
      # Latex figure (float) alignment
      #
      # 'figure_align': 'htbp',
+    'extraclassoptions': 'openany',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
diff --git a/docs/source/index.rst b/docs/source/index.rst
index a55b1f41d..561aa4a85 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -18,6 +18,7 @@ Contents:
    available_notebooks
    advanced
    tutorial
+   _notebooks/index
 
 
 Indices and tables
diff --git a/docs/source/makeAllDocs.sh b/docs/source/makeAllDocs.sh
new file mode 100755
index 000000000..f1c2d96b0
--- /dev/null
+++ b/docs/source/makeAllDocs.sh
@@ -0,0 +1,37 @@
+#!/bin/bash
+
+# first convert notebooks to rst files
+# the list of notebooks to convert:
+
+notebooks=(calversion)
+
+cd _notebooks
+
+echo "Tutorial Example"> index.rst
+echo "================">> index.rst
+echo "" >> index.rst
+echo "Tutorial Notebook:" >> index.rst
+echo "" >> index.rst
+echo ".. toctree::" >> index.rst
+echo "   :maxdepth: 5" >> index.rst
+echo "   :titlesonly:" >> index.rst
+echo "" >> index.rst
+
+for nb in ${notebooks[*]}
+do
+     jupyter nbconvert --to rst ../../../notebooks/Tutorial/${nb}.ipynb --output-dir=./
+     ##fix code blocks
+     sed -i.bak 's/code::/code-block::/g' ${nb}.rst
+     sed -i.bak 's/ipython3/python/g' ${nb}.rst
+     sed -i.bak 's/raw:: latex/math::/g' ${nb}.rst
+     sed -i.bak 's/``/`/g' ${nb}.rst
+     mv ${nb}.rst ${nb}.rst.end
+     echo ".. _${nb}:" > ${nb}.rst
+     cat ${nb}.rst.end >> ${nb}.rst
+     rm ${nb}.rst.end
+     echo "   ${nb}" >> index.rst
+done
+rm *.bak
+
+#cd .. rm api/* sphinx-apidoc -o ./api/ -E ../../iCalibrationDB/
+
-- 
GitLab