Py: Documentation fixes

Author: w1th0utnam3

pysplashsurf/pysplashsurf/docs/source/api.rst

@@ -14,32 +14,34 @@ Functions
 ---------
 
 .. autosummary::
+    barnacle_decimation
     check_mesh_consistency
     convert_tris_to_quads
-    create_aabb_object
-    create_aabb_object_from_points
-    create_mesh_with_data_object
-    create_sph_interpolator_object
-    decimation
+    laplacian_smoothing_normals_parallel
+    laplacian_smoothing_parallel
     marching_cubes_cleanup
     neighborhood_search_spatial_hashing_parallel
-    par_laplacian_smoothing_inplace
-    par_laplacian_smoothing_normals_inplace
     reconstruct_surface
     reconstruction_pipeline
-    write_to_file
+    triangulate_density_map
 
 Classes
 -------
 
 .. autosummary::
     Aabb3d
+    MeshAttribute
     MeshWithData
     MixedTriQuadMesh3d
     NeighborhoodLists
     SphInterpolator
     SurfaceReconstruction
     TriMesh3d
-    TriMeshWithData
     UniformGrid
-    VertexVertexConnectivity
+    VertexVertexConnectivity
+
+Enums
+-----
+
+.. autosummary::
+    MeshType

pysplashsurf/pysplashsurf/docs/source/functions.rst

@@ -5,32 +5,22 @@ All functions infer float precision based on the input (``np.float32`` or ``np.f
 
 .. currentmodule:: pysplashsurf
 
+.. autofunction:: barnacle_decimation
+
 .. autofunction:: check_mesh_consistency
 
 .. autofunction:: convert_tris_to_quads
 
-.. autofunction:: create_aabb_object
-
-.. autofunction:: create_aabb_object_from_points
-
-.. autofunction:: create_mesh_with_data_object
-
-.. autofunction:: create_sph_interpolator_object
+.. autofunction:: laplacian_smoothing_normals_parallel
 
-.. autofunction:: decimation
+.. autofunction:: laplacian_smoothing_parallel
 
 .. autofunction:: marching_cubes_cleanup
 
 .. autofunction:: neighborhood_search_spatial_hashing_parallel
 
-.. autofunction:: par_laplacian_smoothing_inplace
-
-.. autofunction:: par_laplacian_smoothing_normals_inplace
-
 .. autofunction:: reconstruct_surface
 
 .. autofunction:: reconstruction_pipeline
 
-.. autofunction:: reconstruction_pipeline_multi
-
-.. autofunction:: write_to_file
+.. autofunction:: triangulate_density_map

pysplashsurf/pysplashsurf/pysplashsurf.pyi

@@ -84,7 +84,7 @@ class MeshWithData:
     @property
     def mesh(self) -> typing.Union[TriMesh3d, MixedTriQuadMesh3d]:
         r"""
-        The contained mesh without associated data and attributes
+        The wrapped mesh without associated data and attributes
         """
     @property
     def point_attributes(self) -> dict[str, numpy.typing.NDArray]:
@@ -102,7 +102,7 @@ class MeshWithData:
         """
     def copy_mesh(self) -> typing.Union[TriMesh3d, MixedTriQuadMesh3d]:
         r"""
-        Returns a copy of the contained mesh without associated data and attributes
+        Returns a copy of the wrapped mesh without associated data and attributes
         """
     def copy(self) -> MeshWithData:
         r"""
@@ -132,7 +132,7 @@ class MeshWithData:
         """
     def write_to_file(self, path:builtins.str | os.PathLike | pathlib.Path, *, file_format:typing.Optional[builtins.str]='vtk42') -> None:
         r"""
-        Writes the mesh and its attributes to a file using `meshio.write_points_cells`
+        Writes the mesh and its attributes to a file using ``meshio.write_points_cells``
         """
 
 class MixedTriQuadMesh3d:
@@ -163,7 +163,7 @@ class MixedTriQuadMesh3d:
         """
     def write_to_file(self, path:builtins.str | os.PathLike | pathlib.Path, *, file_format:typing.Optional[builtins.str]='vtk42') -> None:
         r"""
-        Writes the mesh to a file using `meshio.write_points_cells`
+        Writes the mesh to a file using ``meshio.write_points_cells``
         """
 
 class NeighborhoodLists:
@@ -263,7 +263,7 @@ class TriMesh3d:
         """
     def write_to_file(self, path:builtins.str | os.PathLike | pathlib.Path, *, file_format:typing.Optional[builtins.str]='vtk42') -> None:
         r"""
-        Writes the mesh to a file using `meshio.write_points_cells`
+        Writes the mesh to a file using ``meshio.write_points_cells``
         """
 
 class UniformGrid:
@@ -278,16 +278,16 @@ class VertexVertexConnectivity:
     """
     def copy_connectivity(self) -> builtins.list[builtins.list[builtins.int]]:
         r"""
-        Returns a copy of the contained connectivity data
+        Returns a copy of the wrapped connectivity data
         """
     def take_connectivity(self) -> builtins.list[builtins.list[builtins.int]]:
         r"""
-        Returns the contained connectivity data by moving it out of this object (zero copy)
+        Returns the wrapped connectivity data by moving it out of this object (zero copy)
         """
 
 class MeshType(Enum):
     r"""
-    Enum specifying the type of mesh contained in a `MeshWithData`
+    Enum specifying the type of mesh wrapped by a ``MeshWithData``
     """
     Tri3d = ...
     r"""

pysplashsurf/src/mesh.rs

@@ -76,12 +76,12 @@ impl PyVertexVertexConnectivity {
 #[gen_stub_pymethods]
 #[pymethods]
 impl PyVertexVertexConnectivity {
-    /// Returns a copy of the contained connectivity data
+    /// Returns a copy of the wrapped connectivity data
     pub fn copy_connectivity(&self) -> Vec<Vec<usize>> {
         self.connectivity.clone()
     }
 
-    /// Returns the contained connectivity data by moving it out of this object (zero copy)
+    /// Returns the wrapped connectivity data by moving it out of this object (zero copy)
     pub fn take_connectivity(&mut self) -> Vec<Vec<usize>> {
         // TODO: Check if this is actually zero-copy with the conversion to Python lists
         std::mem::take(&mut self.connectivity)
@@ -205,7 +205,7 @@ impl PyTriMesh3d {
         PyVertexVertexConnectivity::new(connectivity)
     }
 
-    /// Writes the mesh to a file using `meshio.write_points_cells`
+    /// Writes the mesh to a file using ``meshio.write_points_cells``
     #[pyo3(signature = (path, *, file_format = Some("vtk42")))]
     pub fn write_to_file<'py>(
         this: Bound<'py, Self>,
@@ -304,7 +304,7 @@ impl PyMixedTriQuadMesh3d {
         })
     }
 
-    /// Writes the mesh to a file using `meshio.write_points_cells`
+    /// Writes the mesh to a file using ``meshio.write_points_cells``
     #[pyo3(signature = (path, *, file_format = Some("vtk42")))]
     pub fn write_to_file<'py>(
         this: Bound<'py, Self>,
@@ -336,7 +336,7 @@ where
     Ok(pyarray)
 }
 
-/// Enum specifying the type of mesh contained in a `MeshWithData`
+/// Enum specifying the type of mesh wrapped by a ``MeshWithData``
 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
 #[gen_stub_pyclass_enum]
 #[pyclass]
@@ -644,7 +644,7 @@ impl PyMeshWithData {
         }
     }
 
-    /// The contained mesh without associated data and attributes
+    /// The wrapped mesh without associated data and attributes
     #[getter]
     #[gen_stub(override_return_type(type_repr="typing.Union[TriMesh3d, MixedTriQuadMesh3d]", imports=()))]
     pub fn mesh<'py>(&self, py: Python<'py>) -> Py<PyAny> {
@@ -686,7 +686,7 @@ impl PyMeshWithData {
             .into_py_dict(py)
     }
 
-    /// Returns a copy of the contained mesh without associated data and attributes
+    /// Returns a copy of the wrapped mesh without associated data and attributes
     #[gen_stub(override_return_type(type_repr="typing.Union[TriMesh3d, MixedTriQuadMesh3d]", imports=()))]
     pub fn copy_mesh<'py>(&self, py: Python<'py>) -> PyResult<Bound<'py, PyAny>> {
         match &self.mesh {
@@ -795,7 +795,7 @@ impl PyMeshWithData {
         Ok(())
     }
 
-    /// Writes the mesh and its attributes to a file using `meshio.write_points_cells`
+    /// Writes the mesh and its attributes to a file using ``meshio.write_points_cells``
     #[pyo3(signature = (path, *, file_format = Some("vtk42")))]
     pub fn write_to_file<'py>(
         this: Bound<'py, Self>,