test: add doctests in separate CI job

Author: oscarbenjamin

.github/workflows/buildwheel.yml

@@ -77,3 +77,25 @@ jobs:
           path: wheelhouse
       - run: pip install --find-links wheelhouse python_flint
       - run: python test/test.py
+
+  doctest_wheels:
+    needs: build_wheels
+    name: Doctests for ${{ matrix.python-version }} wheel on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-20.04, windows-2019, macos-12]
+        python-version: ['3.9', '3.10', '3.11']
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - uses: actions/download-artifact@v3
+        with:
+          name: artifact
+          path: wheelhouse
+      - run: pip install --find-links wheelhouse python_flint
+      - run: python test/dtest.py

bin/build_dependencies_unix.sh

@@ -177,6 +177,13 @@ cd arb-$ARBVER
     --disable-static
   make -j3
   make install
+  #
+  # Here make check passes for Linux and OSX but fails for Windows probably
+  # because of a linker error or something like that. It would be nice to
+  # enable this check when it can work for Windows but for now we disable it
+  # because if it fails then we don't get any wheels built.
+  #
+  # ARB_TEST_MULTIPLIER=0.1 make check
 cd ..
 
 # ------------------------------------------------------------------------- #

test/dtest.py

@@ -0,0 +1,10 @@
+import sys
+import doctest
+import flint
+
+sys.stdout.write("doctests...");
+fail, total = doctest.testmod(flint._flint);
+if fail == 0:
+    print("OK")
+else:
+    raise AssertionError("%i of %i doctests failed" % (fail, total))

test/test.py

@@ -446,9 +446,14 @@ def test_arb():
     sys.stdout.write("test_nmod_poly..."); test_nmod_poly(); print("OK")
     sys.stdout.write("test_nmod_mat..."); test_nmod_mat(); print("OK")
     sys.stdout.write("test_arb.."); test_arb(); print("OK")
-    sys.stdout.write("doctests...");
-    fail, total = doctest.testmod(flint._flint);
-    if fail == 0:
-        print("OK")
-    else:
-        raise AssertionError("%i of %i doctests failed" % (fail, total))
+    print("OK")
+    #
+    # The doctests currently fail on Windows so for now we separate them into a
+    # separate test/doctest.py.
+    #
+    #sys.stdout.write("doctests...");
+    #fail, total = doctest.testmod(flint._flint);
+    #if fail == 0:
+    #    print("OK")
+    #else:
+    #    raise AssertionError("%i of %i doctests failed" % (fail, total))