Docs: Ensure tutorial notebooks are Py2/3 cross-compatible.

timstaley · Jan 7, 2018 · c8cdb61 · c8cdb61
1 parent 57f3c37
commit c8cdb61
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 9 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -16,9 +16,10 @@ matrix:
       env: TOXENV=py35
     - python: "3.6"
       env: TOXENV=py36
-
     - python: "2.7"
-      env: TOXENV=docs
+      env: TOXENV=docs2
+    - python: "3.6"
+      env: TOXENV=docs3
 
 install: "pip install tox"
 script: tox

diff --git a/documentation/requirements.txt b/documentation/requirements.txt
@@ -2,4 +2,3 @@ sphinx>=1.4
 sphinx_rtd_theme
 jupyter
 nbsphinx
-nbconvert==5.0.0
diff --git a/documentation/source/tutorial/01-parsing.ipynb b/documentation/source/tutorial/01-parsing.ipynb
@@ -58,7 +58,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "with open('voevent.xml') as f:\n",
+    "with open('voevent.xml','rb') as f:\n",
     "    v = vp.load(f)"
    ]
   },
@@ -375,5 +375,5 @@
   }
  },
  "nbformat": 4,
- "nbformat_minor": 0
+ "nbformat_minor": 1
 }
diff --git a/documentation/source/tutorial/02-authoring.ipynb b/documentation/source/tutorial/02-authoring.ipynb
@@ -219,7 +219,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "with open('my_gaia.xml', 'w') as f:\n",
+    "with open('my_gaia.xml', 'wb') as f:\n",
     "                vp.dump(v, f)"
    ]
   },
@@ -406,5 +406,5 @@
   }
  },
  "nbformat": 4,
- "nbformat_minor": 0
+ "nbformat_minor": 1
 }
diff --git a/tox.ini b/tox.ini
@@ -4,7 +4,7 @@
 # and then run "tox" from this directory.
 
 [tox]
-envlist = py27, py34, py35, py36, docs, coverage-report
+envlist = py27, py34, py35, py36, docs2, docs3, coverage-report
 skip_missing_interpreters = true
 
 [testenv]
@@ -29,7 +29,7 @@ commands =
     coverage report
 
 
-[testenv:docs]
+[testenv:docs2]
 passenv = HOME
 setenv = TOX_DOCS = TRUE
 basepython = python2
@@ -42,3 +42,17 @@ commands=
     pip install -r documentation/requirements.txt
     pip install -e .
     sphinx-build -W -b html -d {envtmpdir}/doctrees documentation/source  {envtmpdir}/html
+
+[testenv:docs3]
+passenv = HOME
+setenv = TOX_DOCS = TRUE
+basepython = python3
+whitelist_externals =
+    pandoc
+deps=
+    sphinx
+commands=
+    env
+    pip install -r documentation/requirements.txt
+    pip install -e .
+    sphinx-build -W -b html -d {envtmpdir}/doctrees documentation/source  {envtmpdir}/html