DOCS docstrings in python source code.

Author: petrasvestartas

docs/acknowledgements.rst

@@ -3,6 +3,7 @@ Acknowledgements
 ********************************************************************************
 
 This package provides Python bindings for selected methods of libigl developed by:
+
 * Tom van Mele, [email protected]
 * Petras Vestartas, [email protected]
 

docs/conf.py

@@ -83,7 +83,11 @@ def setup(app):
 
 # linkcode
 
-linkcode_resolve = sphinx_compas2_theme.get_linkcode_resolve(organization, package)
+import functools
+_linkcode_partial = sphinx_compas2_theme.get_linkcode_resolve(organization, package)
+
+def linkcode_resolve(domain, info):
+    return _linkcode_partial(domain, info)
 
 # extlinks
 

docs/examples/example_curvature_gaussian.py

@@ -54,7 +54,7 @@
 viewer = Viewer()
 
 # Add the colored mesh
-viewer.scene.add(trimesh, use_vertexcolors=True)  # , vertexcolor=vertex_colors)
+viewer.scene.add(trimesh, use_vertexcolors=True, pointcolor=vertex_colors)
 
 # Add normal vectors scaled by Gaussian curvature
 normal_scale = -10

docs/installation.rst

@@ -5,29 +5,14 @@ Installation
 Stable
 ======
 
-Stable releases of :mod:`compas_libigl` can be installed via ``conda-forge``.
-
-.. code-block:: bash
-
-    conda create -n libigl -c conda-forge compas_libigl
-
-or install in your python environment via pip:
+Stable releases of :mod:`compas_libigl` can be installed via pip:
 
 .. code-block:: bash
     
     pip install compas_libigl
 
-
-Several examples use the COMPAS Viewer for visualisation.
-To install :mod:`compas_viewer` in the same environment
+For visualization (optional):
 
 .. code-block:: bash
 
-    conda activate libigl
     pip install compas_viewer
-
-
-Dev Install
-===========
-
-See :doc:`devguide`.

docs/tutorial.rst

@@ -2,67 +2,6 @@
 Tutorial
 ********************************************************************************
 
-.. rst-class:: lead
-
-:mod:`compas_libigl` provides bindings for the libigl library.
-It doesn't cover the entire library, but provides bindings for specific geometry processing functions.
-The functions are organized into the following categories:
-
-Mesh Analysis
-=============
-
-Boundaries and Intersections
-----------------------------
-
-* :func:`compas_libigl.trimesh_boundaries` - Compute boundary loops of a mesh
-* :func:`compas_libigl.intersection_ray_mesh` - Compute intersection of a ray with a mesh
-* :func:`compas_libigl.intersection_rays_mesh` - Compute intersections of multiple rays with a mesh
-
-Curvature Analysis
-------------------
-
-* :func:`compas_libigl.trimesh_gaussian_curvature` - Compute Gaussian curvature at vertices
-* :func:`compas_libigl.trimesh_principal_curvature` - Compute principal curvatures and directions
-
-Geodesic Distances
-------------------
-
-* :func:`compas_libigl.trimesh_geodistance` - Compute geodesic distance from a source vertex
-* :func:`compas_libigl.trimesh_geodistance_multiple` - Compute geodesic distances from multiple source vertices
-
-Mass Properties
----------------
-
-* :func:`compas_libigl.trimesh_massmatrix` - Compute the mass matrix
-
-Mesh Processing
-===============
-
-Remeshing and Isolines
-----------------------
-
-* :func:`compas_libigl.trimesh_isolines` - Extract isolines from a scalar field
-* :func:`compas_libigl.groupsort_isolines` - Sort and group isolines
-* :func:`compas_libigl.trimesh_remesh_along_isoline` - Remesh along a single isoline
-* :func:`compas_libigl.trimesh_remesh_along_isolines` - Remesh along multiple isolines
-
-Parameterization
-----------------
-
-* :func:`compas_libigl.trimesh_harmonic` - Compute harmonic parameterization
-* :func:`compas_libigl.trimesh_lscm` - Compute least squares conformal mapping
-
-Mesh Optimization
------------------
-
-* :func:`compas_libigl.quadmesh_planarize` - Planarize quad mesh faces
-
-Utilities
-=========
-
-* :func:`compas_libigl.get` - Get sample geometry files
-* :func:`compas_libigl.get_beetle` - Get the beetle mesh
-* :func:`compas_libigl.get_armadillo` - Get the armadillo mesh
 
 Input/Output
 ============

src/compas_libigl/boundaries.py

@@ -13,8 +13,8 @@ def trimesh_boundaries(M):
     Parameters
     ----------
     M : tuple[list[list[float]], list[list[int]]]
-        A mesh represented by a list of vertices and a list of faces.
-        The vertices should be 3D points, and faces should be triangles.
+        A mesh represented by a tuple of (vertices, faces)
+        where vertices are 3D points and faces are triangles
 
     Returns
     -------

src/compas_libigl/curvature.py

@@ -12,8 +12,8 @@ def trimesh_gaussian_curvature(M):
     Parameters
     ----------
     M : tuple[list[list[float]], list[list[int]]]
-        A mesh represented by a list of vertices and a list of faces.
-        The vertices should be 3D points, and faces should be triangles.
+        A mesh represented by a tuple of (vertices, faces)
+        where vertices are 3D points and faces are triangles
 
     Returns
     -------
@@ -37,8 +37,8 @@ def trimesh_principal_curvature(M):
     Parameters
     ----------
     M : tuple[list[list[float]], list[list[int]]]
-        A mesh represented by a list of vertices and a list of faces.
-        The vertices should be 3D points, and faces should be triangles.
+        A mesh represented by a tuple of (vertices, faces)
+        where vertices are 3D points and faces are triangles
 
     Returns
     -------

src/compas_libigl/geodistance.py

@@ -13,9 +13,9 @@ def trimesh_geodistance(M, source, method="exact"):
 
     Parameters
     ----------
-    M : tuple[:class:`list`, :class:`list`]
-        A mesh represented by a list of vertices and a list of faces.
-        The vertices should be 3D points, and faces should be triangles.
+    M : tuple[list[list[float]], list[list[int]]]
+        A mesh represented by a tuple of (vertices, faces)
+        where vertices are 3D points and faces are triangles
     source : int
         The index of the source vertex.
     method : str, optional
@@ -52,9 +52,9 @@ def trimesh_geodistance_multiple(M, sources, method="exact"):
 
     Parameters
     ----------
-    M : tuple[:class:`list`, :class:`list`]
-        A mesh represented by a list of vertices and a list of faces.
-        The vertices should be 3D points, and faces should be triangles.
+    M : tuple[list[list[float]], list[list[int]]]
+        A mesh represented by a tuple of (vertices, faces)
+        where vertices are 3D points and faces are triangles
     sources : list[int]
         The indices of the source vertices.
     method : str, optional

src/compas_libigl/intersections.py

@@ -13,7 +13,8 @@ def intersection_ray_mesh(ray, M):
     ray : tuple[list[float], list[float]]
         A ray represented by a point and a direction vector.
     M : tuple[list[list[float]], list[list[int]]]
-        A mesh represented by a list of vertices and a list of faces.
+        A mesh represented by a tuple of (vertices, faces)
+        where vertices are 3D points and faces are triangles
 
     Returns
     -------
@@ -43,7 +44,8 @@ def intersection_rays_mesh(rays, M):
     rays : list[tuple[list[float], list[float]]]
         List of rays, each represented by a point and a direction vector.
     M : tuple[list[list[float]], list[list[int]]]
-        A mesh represented by a list of vertices and a list of faces.
+        A mesh represented by a tuple of (vertices, faces)
+        where vertices are 3D points and faces are triangles
 
     Returns
     -------

src/compas_libigl/isolines.py

@@ -12,9 +12,9 @@ def trimesh_isolines(M, scalars, isovalues):
 
     Parameters
     ----------
-    M : tuple[list[list[float]], list[list[int]]] | :class:`compas.datastructures.Mesh`
-        A mesh represented by a list of vertices and a list of faces,
-        or by a COMPAS mesh object.
+    M : tuple[list[list[float]], list[list[int]]]
+        A mesh represented by a tuple of (vertices, faces)
+        where vertices are 3D points and faces are triangles
     scalars : list[float]
         A list of scalar values, one per vertex of the mesh.
     isovalues : list[float]
@@ -63,7 +63,7 @@ def groupsort_isolines(vertices, edges, indices):
 
     Returns
     -------
-    list[list[:class:`compas.geometry.Polyline`]]
+    list[list[compas.geometry.Polyline]]
         A list of polyline groups, where each group corresponds to an isoline level.
         Each polyline represents a continuous segment of an isoline.