🔧 MAINTAIN: Add sphinx v2 CI and tox (#233)

Author: chrisjsewell

.github/workflows/tests.yml

@@ -26,6 +26,10 @@ jobs:
     strategy:
       matrix:
         python-version: [3.6, 3.7, 3.8]
+        sphinx: [">=3,<4"]
+        include:
+          - python-version: 3.8
+            sphinx: ">=2,<3"
 
     steps:
     - uses: actions/checkout@v2
@@ -36,6 +40,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
+        pip install "sphinx${{ matrix.sphinx }}"
         pip install -e .[testing]
     - name: Run pytest
       run: |
@@ -44,7 +49,7 @@ jobs:
       # for some reason the tests/conftest.py::check_nbs fixture breaks pytest-cov's cov-report outputting
       # this is why we run `coverage xml` afterwards (required by codecov)
     - name: Upload to Codecov
-      if: matrix.python-version == 3.7 && github.repository == 'executablebooks/MyST-NB'
+      if: matrix.python-version == 3.7 && matrix.sphinx == '>=3,<4' && github.repository == 'executablebooks/MyST-NB'
       uses: codecov/codecov-action@v1
       with:
         name: myst-nb-pytests-py3.7

codecov.yml

@@ -0,0 +1,10 @@
+coverage:
+  status:
+    project:
+      default:
+        target: 85%
+        threshold: 0.5%
+    patch:
+      default:
+        target: 80%
+        threshold: 0.5%

docs/develop/contributing.md

@@ -66,13 +66,20 @@ All functions and class methods should be annotated with types and include a doc
 
 ## Testing
 
-For code tests:
+For code tests, MyST-NB uses [pytest](https://docs.pytest.org)):
 
 ```shell
 >> cd MyST-NB
 >> pytest
 ```
 
+You can also use [tox](https://tox.readthedocs.io), to run the tests in multiple isolated environments (see the `tox.ini` file for available test environments):
+
+```shell
+>> cd MyST-NB
+>> tox
+```
+
 For documentation build tests:
 
 ```shell

tox.ini

@@ -0,0 +1,30 @@
+# To use tox, see https://tox.readthedocs.io
+# Simply pip or conda install tox
+# If you use conda, you may also want to install tox-conda
+# then run `tox` or `tox -- {pytest args}`
+# To run in parallel using `tox -p` (this does not appear to work for this repo)
+
+# To rebuild the tox environment, for example when dependencies change, use
+# `tox -r`
+
+# Note: if the following error is encountered: `ImportError while loading conftest`
+# then then deleting compiled files has been found to fix it: `find . -name \*.pyc -delete`
+
+[tox]
+envlist = py{36,37,38}-sphinx{2,3},docs
+
+[testenv:py{36,37,38}-sphinx{2,3}]
+recreate = false
+extras = testing
+deps =
+    sphinx2: sphinx>=2,<3
+    sphinx3: sphinx>=3,<4
+commands = pytest {posargs}
+
+[testenv:docs]
+recreate = false
+extras = rtd
+whitelist_externals = rm
+commands =
+    rm -rf docs/_build
+    sphinx-build -nW --keep-going -b html docs/ docs/_build/html