Skip to content

Commit

Permalink
small docs fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
tomvanmele committed Sep 19, 2023
1 parent 4f9f1de commit a65c7a4
Show file tree
Hide file tree
Showing 18 changed files with 15 additions and 126 deletions.
1 change: 0 additions & 1 deletion docs/reference/compas.data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ Validators
is_float3
is_float4x4
is_item_iterable
validate_data


Exceptions
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/compas.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,7 @@ Modules
compas.geometry
compas.numerical
compas.plugins
compas.robots
compas.rpc
compas.topology
compas.utilities


69 changes: 0 additions & 69 deletions docs/reference/compas.utilities.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/reference/compas_blender.artists.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ Geometry Artists
CylinderArtist
FrameArtist
LineArtist
PlaneArtist
PointArtist
PointcloudArtist
PolygonArtist
Expand Down
1 change: 0 additions & 1 deletion docs/reference/compas_blender.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,5 @@ Modules
compas_blender.artists
compas_blender.conversions
compas_blender.geometry
compas_blender.utilities


5 changes: 0 additions & 5 deletions docs/reference/compas_blender.utilities.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/reference/compas_ghpython.artists.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ Geometry Artists
CylinderArtist
FrameArtist
LineArtist
PlaneArtist
PointArtist
PolygonArtist
PolyhedronArtist
Expand Down
1 change: 0 additions & 1 deletion docs/reference/compas_rhino.geometry.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ Classes
:toctree: generated/
:nosignatures:

RhinoCurve
RhinoNurbsCurve
RhinoNurbsSurface

Expand Down
4 changes: 2 additions & 2 deletions src/compas/datastructures/halfface/halfface.py
Original file line number Diff line number Diff line change
Expand Up @@ -2519,8 +2519,8 @@ def is_edge_on_boundary(self, edge):
--------
:meth:`is_vertex_on_boundary`, :meth:`is_face_on_boundary`, :meth:`is_cell_on_boundary`
Note
----
Notes
-----
This method simply checks if u-v or v-u is on the edge of the volmesh.
The direction u-v does not matter.
Expand Down
15 changes: 0 additions & 15 deletions src/compas/files/ply.py
Original file line number Diff line number Diff line change
Expand Up @@ -144,21 +144,6 @@ class PLYReader(object):
The faces found in the file.
Each face is a dictionary of property names and property values.
Class Attributes
----------------
keywords : list[str]
Reserved keywords in PLY format language.
property_types : dict[str, object]
Mapping between PLY property types and Python types.
binary_property_types : dict[str, str]
Mapping between PLY property types and binary type strings.
number_of_bytes_per_type : dict[str, int]
Mapping between PLY property types and number of bytes.
struct_format_per_type : dict[str, str]
Mapping between PLY property types and struct formats.
binary_byte_order : dict[str, str]
Mapping between endian type and endian symbol.
"""

keywords = ["ply", "format", "comment", "element", "property", "end_header"]
Expand Down
9 changes: 0 additions & 9 deletions src/compas/geometry/brep/brep.py
Original file line number Diff line number Diff line change
Expand Up @@ -168,15 +168,6 @@ class Brep(Geometry):
is_surface : bool, read-only
True if this brep is a surface, False otherwise.
Other Attributes
----------------
native_brep
The underlying instance of the backend brep.
type : :class:`~compas.geometry.BrepType`, read-only
The type of Brep shape.
orientation : :class:`~compas.geometry.BrepOrientation`, read-obly
Orientation of the shape.
"""

def __new__(cls, *args, **kwargs):
Expand Down
6 changes: 0 additions & 6 deletions src/compas/geometry/surfaces/conical.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,6 @@ class ConicalSurface(Surface):
frame : :class:`Frame`
The local coordinate system of the cone.
Attributes
----------
Examples
--------
"""

DATASCHEMA = {
Expand Down
6 changes: 0 additions & 6 deletions src/compas/geometry/surfaces/cylindrical.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,6 @@ class CylindricalSurface(Surface):
frame : :class:`Frame`
The local coordinate system of the cylinder.
Attributes
----------
Examples
--------
"""

DATASCHEMA = {
Expand Down
3 changes: 0 additions & 3 deletions src/compas/geometry/surfaces/planar.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,6 @@ class PlanarSurface(Surface):
ysize : float, optional
The size of the surface in the local Y-direction.
Attributes
----------
"""

DATASCHEMA = {
Expand Down
5 changes: 5 additions & 0 deletions src/compas_blender/conversions/meshes.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@
from compas.geometry import Translation
from compas.datastructures import Mesh

# To Do
# -----
# - [ ] Write COMPAS Mesh attributes to Blender
# - [ ] Read Mesh attributes from Blender to COMPAS
# - [ ] Include results of modifiers in VOMPAS Mesh

# =============================================================================
# To Blender
Expand Down
7 changes: 5 additions & 2 deletions src/compas_rhino/conversions/meshes.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
from __future__ import division
from __future__ import print_function

from itertools import izip_longest # type: ignore
try:
from itertools import zip_longest
except ImportError:
from itertools import izip_longest as zip_longest # type: ignore

from System.Drawing import Color as SystemColor # type: ignore
from System.Array import CreateInstance # type: ignore
Expand Down Expand Up @@ -158,7 +161,7 @@ def vertices_and_faces_to_rhino(
if disjoint:
vertexcolors = []

for face, facecolor in izip_longest(faces, facecolors or []):
for face, facecolor in zip_longest(faces, facecolors or []):
f = len(face)

if f < 3:
Expand Down
4 changes: 2 additions & 2 deletions src/compas_rhino/geometry/brep/brep.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
from compas.geometry import Plane

from compas_rhino.conversions import box_to_rhino
from compas_rhino.conversions import xform_to_rhino
from compas_rhino.conversions import transformation_to_rhino
from compas_rhino.conversions import frame_to_rhino
from compas_rhino.conversions import cylinder_to_rhino
from compas_rhino.conversions import sphere_to_rhino
Expand Down Expand Up @@ -260,7 +260,7 @@ def transform(self, matrix):
None
"""
self._brep.Transform(xform_to_rhino(matrix))
self._brep.Transform(transformation_to_rhino(matrix))

def trim(self, trimming_plane, tolerance=TOLERANCE):
"""Trim this brep by the given trimming plane
Expand Down
1 change: 1 addition & 0 deletions src/compas_rhino/geometry/trimesh/curvature.py
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,7 @@ def trimesh_mean_curvature(M):
@plugin(category="trimesh", requires=["Rhino"])
def trimesh_principal_curvature(M):
r"""Compute the principal curvature of a triangle mesh.
Parameters
----------
M : tuple[sequence[[float, float, float] | :class:`~compas.geometry.Point`], sequence[[int, int, int]]]
Expand Down

0 comments on commit a65c7a4

Please sign in to comment.