Merge pull request #989 from Licini/workflow

test docs

Author: tomvanmele

.github/workflows/docs.yml

@@ -17,11 +17,12 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - uses: compas-dev/compas-actions.docs@v1.3.0
+      - uses: compas-dev/compas-actions.docs@v1.4.1
         id: docs
         with:
           dest: deploy
           build_to_subfolder: true
+          test_docs: true
 
       - name: Deploy docs
         if: success() && steps.docs.outputs.commit_type != 'pull'

CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+* Added doc test step in CI/CD.
+
 ### Changed
 
 ### Removed

src/compas/datastructures/mesh/matrices.py

@@ -56,8 +56,6 @@ def mesh_adjacency_matrix(mesh, rtype='array'):
     <class 'numpy.ndarray'>
 
     >>> A = mesh_adjacency_matrix(mesh, rtype='csr')
-    >>> type(A)
-    <class 'scipy.sparse.csr.csr_matrix'>
 
     """
     key_index = mesh.key_index()
@@ -89,8 +87,6 @@ def mesh_connectivity_matrix(mesh, rtype='array'):
     <class 'numpy.ndarray'>
 
     >>> C = mesh_connectivity_matrix(mesh, rtype='csr')
-    >>> type(C)
-    <class 'scipy.sparse.csr.csr_matrix'>
 
     >>> xyz = asarray(mesh.vertices_attributes('xyz'))
     >>> C = mesh_connectivity_matrix(mesh, rtype='csr')
@@ -126,8 +122,6 @@ def mesh_degree_matrix(mesh, rtype='array'):
     <class 'numpy.ndarray'>
 
     >>> D = mesh_degree_matrix(mesh, rtype='csr')
-    >>> type(D)
-    <class 'scipy.sparse.csr.csr_matrix'>
 
     >>> D = mesh_degree_matrix(mesh)
     >>> D.diagonal()
@@ -181,8 +175,6 @@ def mesh_face_matrix(mesh, rtype='array'):
     <class 'numpy.ndarray'>
 
     >>> F = mesh_face_matrix(mesh, rtype='csr')
-    >>> type(F)
-    <class 'scipy.sparse.csr.csr_matrix'>
 
     >>> from numpy import allclose
     >>> xyz = asarray(mesh.vertices_attributes('xyz'))
@@ -247,8 +239,6 @@ def mesh_laplacian_matrix(mesh, rtype='csr'):
     <class 'numpy.ndarray'>
 
     >>> L = mesh_face_matrix(mesh, rtype='csr')
-    >>> type(L)
-    <class 'scipy.sparse.csr.csr_matrix'>
 
     >>> xyz = asarray(mesh.vertices_attributes('xyz'))
     >>> L = mesh_laplacian_matrix(mesh)

src/compas/geometry/_core/distance.py

@@ -606,13 +606,12 @@ def closest_points_in_cloud_numpy(points, cloud, threshold=10**7, distances=True
 
     Examples
     --------
+    >>> from numpy import allclose
     >>> points = [[0, 0, 0], [1, 0, 0], [1, 1, 0], [0, 1, 0]]
     >>> cloud = [[0, 0, 0], [1, 0, 0], [1, 1, 0], [0, 1, 0]]
-    >>> closest_points_in_cloud_numpy(points, cloud, distances=True)
-    (array([0, 1, 2, 3], dtype=int64), array([[0.        , 1.        , 1.41421356, 1.        ],
-           [1.        , 0.        , 1.        , 1.41421356],
-           [1.41421356, 1.        , 0.        , 1.        ],
-           [1.        , 1.41421356, 1.        , 0.        ]]))
+    >>> cp = closest_points_in_cloud_numpy(points, cloud, distances=True)
+    >>> allclose(cp[1], [[0, 1, 1.4142, 1], [1, 0, 1, 1.4142], [1.4142, 1, 0, 1], [1, 1.4142, 1, 0]])
+    True
 
     """
     from numpy import asarray

src/compas/numerical/linalg.py

@@ -166,8 +166,10 @@ def dof(A, tol=0.001, condition=False):
 
     Examples
     --------
-    >>> dof([[2, -1, 3], [1, 0, 1], [0, 2, -1], [1, 1, 4]], condition=True)
-    (0, 1, 5.073596551276727)
+    >>> from numpy import allclose
+    >>> d = dof([[2, -1, 3], [1, 0, 1], [0, 2, -1], [1, 1, 4]], condition=True)
+    >>> allclose(d, (0, 1, 5.073596551))
+    True
 
     """
     A = atleast_2d(asarray(A, dtype=float))

src/compas/rpc/proxy.py

@@ -89,13 +89,13 @@ class Proxy(object):
     Minimal example showing connection to the proxy server, and ensuring the
     server is disposed after using it:
 
-    >>> from compas.rpc import Proxy
-    >>> with Proxy('compas.numerical') as numerical:
-    ...     pass
-    ...
-    Starting a new proxy server...
-    New proxy server started.
-    Stopping the server proxy.
+    >>> from compas.rpc import Proxy                        # doctest: +SKIP
+    >>> with Proxy('compas.numerical') as numerical:        # doctest: +SKIP
+    ...     pass                                            # doctest: +SKIP
+    ...                                                     # doctest: +SKIP
+    Starting a new proxy server...                          # doctest: +SKIP
+    New proxy server started.                               # doctest: +SKIP
+    Stopping the server proxy.                              # doctest: +SKIP
     """
 
     def __init__(self, package=None, python=None, url='http://127.0.0.1', port=1753, service=None, max_conn_attempts=100, autoreload=True, capture_output=True):