remove RST directives from docstrings

Author: jf---

src/compas/__init__.py

@@ -168,12 +168,12 @@ def get(filename):
     The ``compas.get`` function is meant to be used in combination with the static
     constructors of the data structures.
 
-    .. code-block:: python
+    ```python
+    import compas
+    from compas.datastructures import Mesh
 
-        import compas
-        from compas.datastructures import Mesh
-
-        mesh = Mesh.from_obj(compas.get("faces.obj"))
+    mesh = Mesh.from_obj(compas.get("faces.obj"))
+    ```
 
     """
     filename = filename.strip("/")
@@ -210,12 +210,12 @@ def get_bunny(localstorage=None):
     Therefore, the returned path should be used in combination with the ``PLY``
     file reader, or with the ``from_ply`` constructor function for meshes.
 
-    .. code-block:: python
-
-        import compas
-        from compas.datastructures import Mesh
+    ```python
+    import compas
+    from compas.datastructures import Mesh
 
-        mesh = Mesh.from_ply(compas.get_bunny())
+    mesh = Mesh.from_ply(compas.get_bunny())
+    ```
 
     """
     import tarfile

src/compas/geometry/_core/_algebra.py

@@ -2227,12 +2227,12 @@ def matrix_from_basis_vectors(xaxis, yaxis):
 
     Notes
     -----
-    .. code-block:: none
-
-        [ x0  y0  z0  0 ]
-        [ x1  y1  z1  0 ]
-        [ x2  y2  z2  0 ]
-        [  0   0   0  1 ]
+    ```
+    [ x0  y0  z0  0 ]
+    [ x1  y1  z1  0 ]
+    [ x2  y2  z2  0 ]
+    [  0   0   0  1 ]
+    ```
 
     Examples
     --------
@@ -2306,12 +2306,12 @@ def matrix_from_translation(translation):
 
     Notes
     -----
-    .. code-block:: none
-
-        [ .  .  .  0 ]
-        [ .  .  .  1 ]
-        [ .  .  .  2 ]
-        [ .  .  .  . ]
+    ```
+    [ .  .  .  0 ]
+    [ .  .  .  1 ]
+    [ .  .  .  2 ]
+    [ .  .  .  . ]
+    ```
 
     Examples
     --------
@@ -2472,12 +2472,12 @@ def matrix_from_perspective_entries(perspective):
 
     Notes
     -----
-    .. code-block:: none
-
-        [ .  .  .  . ]
-        [ .  .  .  . ]
-        [ .  .  .  . ]
-        [ 0  1  2  3 ]
+    ```
+    [ .  .  .  . ]
+    [ .  .  .  . ]
+    [ .  .  .  . ]
+    [ 0  1  2  3 ]
+    ```
 
     """
     M = identity_matrix(4)
@@ -2503,12 +2503,12 @@ def matrix_from_shear_entries(shear_entries):
 
     Notes
     -----
-    .. code-block:: none
-
-        [ .  0  1  . ]
-        [ .  .  2  . ]
-        [ .  .  .  . ]
-        [ .  .  .  . ]
+    ```
+    [ .  0  1  . ]
+    [ .  .  2  . ]
+    [ .  .  .  . ]
+    [ .  .  .  . ]
+    ```
 
     Examples
     --------
@@ -2597,12 +2597,12 @@ def matrix_from_scale_factors(scale_factors):
 
     Notes
     -----
-    .. code-block:: python
-
-        [ 0  .  .  . ]
-        [ .  1  .  . ]
-        [ .  .  2  . ]
-        [ .  .  .  . ]
+    ```
+    [ 0  .  .  . ]
+    [ .  1  .  . ]
+    [ .  .  2  . ]
+    [ .  .  .  . ]
+    ```
 
     Examples
     --------

src/compas/rpc/server.py

@@ -20,25 +20,25 @@ class Server(SimpleXMLRPCServer):
 
     Examples
     --------
-    .. code-block:: python
+    ```python
+    # service.py
 
-        # service.py
+    from compas.rpc import Server
+    from compas.rpc import Dispatcher
 
-        from compas.rpc import Server
-        from compas.rpc import Dispatcher
 
+    class DefaultService(Dispatcher):
+        pass
 
-        class DefaultService(Dispatcher):
-            pass
 
+    if __name__ == "__main__":
+        server = Server(("localhost", 8888))
 
-        if __name__ == "__main__":
-            server = Server(("localhost", 8888))
-
-            server.register_function(server.ping)
-            server.register_function(server.remote_shutdown)
-            server.register_instance(DefaultService())
-            server.serve_forever()
+        server.register_function(server.ping)
+        server.register_function(server.remote_shutdown)
+        server.register_instance(DefaultService())
+        server.serve_forever()
+    ```
 
     """
 

src/compas/utilities/azync.py

@@ -73,23 +73,23 @@ def await_callback(async_func, callback_name="callback", errback_name=None, *arg
     The following example shows how to await an async function (``do_async_stuff`` in
     the example), using this utility:
 
-    .. code-block:: python
+    ```python
+    from compas.utilities import await_callback
 
-        from compas.utilities import await_callback
 
+    def do_async_stuff(callback):
+        from threading import Thread
 
-        def do_async_stuff(callback):
-            from threading import Thread
+        def runner(cb):
+            print("doing async stuff")
+            # ..
+            cb("done")
 
-            def runner(cb):
-                print("doing async stuff")
-                # ..
-                cb("done")
+        Thread(target=runner, args=(callback,)).start()
 
-            Thread(target=runner, args=(callback,)).start()
 
-
-        result = await_callback(do_async_stuff)
+    result = await_callback(do_async_stuff)
+    ```
 
     """
     wait_event = threading.Event()

src/compas/utilities/decorators.py

@@ -104,15 +104,15 @@ def print_profile(func):
 
     Examples
     --------
-    .. code-block:: python
-
-        @print_profile
-        def f(n):
-            return sum(for i in range(n))
-
-        print(f(100))
-        print(f.__doc__)
-        print(f.__name__)
+    ```python
+    @print_profile
+    def f(n):
+        return sum(for i in range(n))
+
+    print(f(100))
+    print(f.__doc__)
+    print(f.__name__)
+    ```
 
     """
 

src/compas/utilities/remote.py

@@ -24,16 +24,16 @@ def download_file_from_remote(source, target, overwrite=True):
 
     Examples
     --------
-    .. code-block:: python
+    ```python
+    import os
+    import compas
+    from compas.utilities.remote import download_file_from_remote
 
-        import os
-        import compas
-        from compas.utilities.remote import download_file_from_remote
+    source = "https://raw.githubusercontent.com/compas-dev/compas/main/data/faces.obj"
+    target = os.path.join(compas.APPDATA, "data", "faces.obj")
 
-        source = "https://raw.githubusercontent.com/compas-dev/compas/main/data/faces.obj"
-        target = os.path.join(compas.APPDATA, "data", "faces.obj")
-
-        download_file_from_remote(source, target)
+    download_file_from_remote(source, target)
+    ```
 
     """
     parent = os.path.abspath(os.path.dirname(target))

src/compas_blender/install.py

@@ -28,15 +28,15 @@ def install(version=None, packages=None, clean=False):
 
     Examples
     --------
-    .. code-block:: python
+    ```python
+    import compas_blender.install
 
-        import compas_blender.install
+    compas_blender.install.install()
+    ```
 
-        compas_blender.install.install()
-
-    .. code-block:: bash
-
-        python -m compas_blender.install
+    ```bash
+    python -m compas_blender.install
+    ```
 
     """
     version = compas_blender._check_blender_version(version)