regenerate rst

Author: tomvanmele

docs/api/compas.colors.rst

@@ -7,6 +7,7 @@ compas.colors
 
 .. rst-class:: lead
 
+
 This package defines a color and color map class,
 that can be used to work wihth colors in a consistent way across color spaces.
 
@@ -21,6 +22,3 @@ Classes
     Color
     ColorDict
     ColorMap
-
-
-

docs/api/compas.data.rst

@@ -7,6 +7,7 @@ compas.data
 
 .. rst-class:: lead
 
+
 This package defines the core infrastructure for data serialisation in the COMPAS framework.
 It provides a base class for data objects, a JSON encoder and decoder, serialisers and deserialisers, and schema validation.
 

docs/api/compas.datastructures.rst

@@ -7,6 +7,7 @@ compas.datastructures
 
 .. rst-class:: lead
 
+
 This package defines the core data structures of the COMPAS framework.
 The data structures provide a structured way of storing and accessing data on individual components of both topological and geometrical objects.
 
@@ -46,6 +47,10 @@ Functions
 
     mesh_add_vertex_to_face_edge
     mesh_adjacency_matrix
+    mesh_bounding_box
+    mesh_bounding_box_xy
+    mesh_collapse_edge
+    mesh_connected_components
     mesh_connectivity_matrix
     mesh_conway_ambo
     mesh_conway_bevel
@@ -64,16 +69,27 @@ Functions
     mesh_delete_duplicate_vertices
     mesh_disconnected_faces
     mesh_disconnected_vertices
+    mesh_dual
     mesh_explode
+    mesh_face_adjacency
     mesh_face_matrix
     mesh_flatness
+    mesh_flip_cycles
     mesh_insert_vertex_on_edge
+    mesh_is_connected
     mesh_laplacian_matrix
+    mesh_merge_faces
     mesh_offset
     mesh_planarize_faces
     mesh_quads_to_triangles
+    mesh_slice_plane
+    mesh_smooth_area
     mesh_smooth_centerofmass
+    mesh_smooth_centroid
     mesh_split_edge
+    mesh_split_face
+    mesh_split_strip
+    mesh_subdivide
     mesh_subdivide_catmullclark
     mesh_subdivide_corner
     mesh_subdivide_doosabin
@@ -82,17 +98,39 @@ Functions
     mesh_subdivide_tri
     mesh_substitute_vertex_in_faces
     mesh_thicken
+    mesh_transform
+    mesh_transformed
+    mesh_unify_cycles
     mesh_unweld_edges
     mesh_unweld_vertices
     mesh_weld
     meshes_join
     meshes_join_and_weld
+    network_adjacency_matrix
+    network_complement
+    network_connectivity_matrix
+    network_count_crossings
+    network_degree_matrix
     network_disconnected_edges
     network_disconnected_nodes
+    network_embed_in_plane
     network_embed_in_plane_proxy
     network_explode
+    network_find_crossings
+    network_find_cycles
+    network_is_connected
+    network_is_crossed
+    network_is_planar
+    network_is_planar_embedding
+    network_is_xy
     network_join_edges
+    network_laplacian_matrix
     network_polylines
+    network_shortest_path
+    network_smooth_centroid
+    network_split_edge
+    network_transform
+    network_transformed
     trimesh_collapse_edge
     trimesh_cotangent_laplacian_matrix
     trimesh_descent
@@ -105,6 +143,9 @@ Functions
     trimesh_subdivide_loop
     trimesh_swap_edge
     trimesh_vertexarea_matrix
+    volmesh_bounding_box
+    volmesh_transform
+    volmesh_transformed
 
 
 Functions using Numpy
@@ -125,6 +166,3 @@ In environments where numpy is not available, these functions can still be acces
     mesh_transformed_numpy
     trimesh_pull_points_numpy
     trimesh_samplepoints_numpy
-
-
-

docs/api/compas.files.rst

@@ -7,6 +7,7 @@ compas.files
 
 .. rst-class:: lead
 
+
 This package defines a number of file formats and provides functionality for reading and writing data in these formats.
 
 
@@ -33,6 +34,3 @@ Functions
     :nosignatures:
 
     prettify_string
-
-
-

docs/api/compas.geometry.rst

@@ -7,6 +7,7 @@ compas.geometry
 
 .. rst-class:: lead
 
+
 This package defines all functionality for working with geometry in COMPAS.
 It provides classes representing geometric primitives, transformations, (NURBS) curves and surfaces,
 shapes, general polygons and polyhedrons, boundary representations (B-reps), and a number of geometry processing algorithms.
@@ -26,6 +27,7 @@ Classes
     BrepEdge
     BrepError
     BrepFace
+    BrepFilletError
     BrepInvalidError
     BrepLoop
     BrepOrientation
@@ -39,6 +41,7 @@ Classes
     Cone
     ConicalSurface
     Curve
+    CurveType
     Cylinder
     CylindricalSurface
     Ellipse
@@ -67,6 +70,7 @@ Classes
     Sphere
     SphericalSurface
     Surface
+    SurfaceType
     ToroidalSurface
     Torus
     Transformation
@@ -137,8 +141,6 @@ Functions
     compose_matrix
     compute_basisfuncs
     compute_basisfuncsderivs
-    conforming_delaunay_triangulation
-    constrained_delaunay_triangulation
     construct_knotvector
     convex_hull
     convex_hull_xy
@@ -148,7 +150,6 @@ Functions
     dehomogenize_vectors
     delaunay_from_points
     delaunay_from_points
-    delaunay_triangulation
     discrete_coons_patch
     distance_line_line
     distance_point_line
@@ -182,13 +183,11 @@ Functions
     intersection_line_segment
     intersection_line_segment_xy
     intersection_line_triangle
-    intersection_mesh_mesh
     intersection_plane_circle
     intersection_plane_plane
     intersection_plane_plane_plane
     intersection_polyline_box_xy
     intersection_polyline_plane
-    intersection_ray_mesh
     intersection_segment_plane
     intersection_segment_polyline
     intersection_segment_polyline_xy
@@ -203,6 +202,7 @@ Functions
     is_coplanar
     is_matrix_square
     is_parallel_line_line
+    is_parallel_vector_vector
     is_point_behind_plane
     is_point_in_circle
     is_point_in_circle_xy
@@ -322,18 +322,6 @@ Functions
     translate_points_xy
     translation_from_matrix
     transpose_matrix
-    trimesh_gaussian_curvature
-    trimesh_geodistance
-    trimesh_harmonic
-    trimesh_isolines
-    trimesh_lscm
-    trimesh_massmatrix
-    trimesh_mean_curvature
-    trimesh_principal_curvature
-    trimesh_remesh
-    trimesh_remesh_along_isoline
-    trimesh_remesh_constrained
-    trimesh_slice
     tween_points
     tween_points_distance
     vector_average
@@ -395,7 +383,22 @@ Pluggables are functions that don't have an actual implementation, but receive a
     boolean_symmetric_difference_polygon_polygon
     boolean_union_mesh_mesh
     boolean_union_polygon_polygon
+    conforming_delaunay_triangulation
+    constrained_delaunay_triangulation
+    delaunay_triangulation
+    intersection_mesh_mesh
+    intersection_ray_mesh
+    oriented_bounding_box
     quadmesh_planarize
-
-
-
+    trimesh_gaussian_curvature
+    trimesh_geodistance
+    trimesh_harmonic
+    trimesh_isolines
+    trimesh_lscm
+    trimesh_massmatrix
+    trimesh_mean_curvature
+    trimesh_principal_curvature
+    trimesh_remesh
+    trimesh_remesh_along_isoline
+    trimesh_remesh_constrained
+    trimesh_slice

docs/api/compas.numerical.rst

@@ -13,10 +13,8 @@ In future versions, this package will disappear,
 and its functionality will be integrated into the geometry and datastructure packages directly.
 
 
-Functions using Numpy
-=====================
-
-In environments where numpy is not available, these functions can still be accessed through RPC.
+Functions
+=========
 
 .. autosummary::
     :toctree: generated/
@@ -36,7 +34,6 @@ In environments where numpy is not available, these functions can still be acces
     normalizerow
     normrow
     nullspace
-    pca_numpy
     pivots
     rank
     rot90
@@ -47,6 +44,18 @@ In environments where numpy is not available, these functions can still be acces
     uvw_lengths
 
 
+Functions using Numpy
+=====================
+
+In environments where numpy is not available, these functions can still be accessed through RPC.
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    pca_numpy
+
+
 Pluggables
 ==========
 

docs/api/compas.plugins.rst

@@ -7,6 +7,7 @@ compas.plugins
 
 .. rst-class:: lead
 
+
 COMPAS has an extensible architecture based on plugins that allows to
 customize and extend the functionality of the core framework.
 
@@ -19,6 +20,7 @@ Classes
     :nosignatures:
 
     IncompletePluginImplError
+    PluginDefaultNotAvailableError
     PluginManager
     PluginNotInstalledError
     PluginValidator
@@ -33,3 +35,4 @@ Functions
 
     pluggable
     plugin
+    plugin_manager

docs/api/compas.rpc.rst

@@ -29,4 +29,3 @@ Classes
     RPCClientError
     RPCServerError
     Server
-    XFunc

docs/api/compas.scene.rst

@@ -37,7 +37,7 @@ Functions
     :toctree: generated/
     :nosignatures:
 
-    build_scene_object
+    get_sceneobject_cls
     register
 
 

docs/api/compas.tolerance.rst

@@ -1,3 +1,4 @@
+
 ********************************************************************************
 compas.tolerance
 ********************************************************************************
@@ -6,13 +7,32 @@ compas.tolerance
 
 .. rst-class:: lead
 
-This package provides functionality for working with geometric tolerances in COMPAS.
+
+The tolerance module provides functionality to deal with tolerances consistently across all other COMPAS packages.
+
 
 Classes
 =======
 
+
+
 .. autosummary::
     :toctree: generated/
     :nosignatures:
 
     Tolerance
+
+
+Functions
+=========
+
+
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    TOL
+
+
+