update docs

Author: tomvanmele

docs/index.rst

@@ -2,19 +2,18 @@
 COMPAS OCC
 ********************************************************************************
 
-.. figure:: /_images/compas_occ.png
-     :figclass: figure
-     :class: figure-img img-fluid
-
 .. rst-class:: lead
 
 COMPAS OCC provides an easy-to-use interface to the Python bindings
 of the `3D modelling kernel of Open CasCade <https://www.opencascade.com/open-cascade-technology/>`_.
 
+.. figure:: /_images/compas_occ.png
+     :figclass: figure
+     :class: figure-img img-fluid
 
-:mod:`compas_occ.geometry` defines :class:`compas_occ.geometry.Curve`, :class:`compas_occ.geometry.NurbsCurve`,
-:class:`compas_occ.geometry.Surface` and :class:`compas_occ.geometry.NurbsSurface`, which are wrappers around the
-``Geom_Curve`` [1]_, ``Geom_BSplineCurve`` [2]_, ``Geom_Surface`` [3]_ and ``Geom_BSplineSurface`` [4]_ objects of OCC, repsectively.
+:mod:`compas_occ.geometry` defines :class:`~compas_occ.geometry.Curve`, :class:`~compas_occ.geometry.NurbsCurve`,
+:class:`~compas_occ.geometry.Surface` and :class:`~compas_occ.geometry.NurbsSurface`, which are wrappers around
+``Geom_Curve`` [1]_, ``Geom_BSplineCurve`` [2]_, ``Geom_Surface`` [3]_ and ``Geom_BSplineSurface`` [4]_ of OCC, repsectively.
 The :mod:`compas_occ` wrappers provide an API for working with NURBS curves and surfaces similar to the API of RhinoCommon.
 
 :mod:`compas_occ.brep` is a package for working with Boundary Representation (BRep) objects

src/compas_occ/brep/brepedge.py

@@ -34,8 +34,6 @@ class BRepEdge:
 
     Attributes
     ----------
-    edge : ``TopoDS_Edge``
-        The underlying OCC topological edge data structure.
     type : :class:`BRepEdge.CurveType`, read-only
         The type of the geometric curve underlying the topological edge.
     is_line : bool, read-only
@@ -54,16 +52,21 @@ class BRepEdge:
         True if the underlying curve is a bspline curve.
     is_other : bool, read-only
         True if the underlying curve is an other type of curve.
-    vertices : list[:class:`compas_occ.brep.BRepVertex`], read-only
+    vertices : list[:class:`~compas_occ.brep.BRepVertex`], read-only
         The topological vertices of the edge.
-    first_vertex : :class:`compas_occ.brep.BRepVertex`, read-only
+    first_vertex : :class:`~compas_occ.brep.BRepVertex`, read-only
         The first vertex with forward orientation.
-    last_vertex : :class:`compas_occ.brep.BRepVertex`, read-only
+    last_vertex : :class:`~compas_occ.brep.BRepVertex`, read-only
         The first vertex with reversed orientation.
+    curve : :class:`~compas_occ.geometry.Curve`
+        Curve geometry from the edge adaptor.
+
+    Other Attributes
+    ----------------
+    edge : ``TopoDS_Edge``
+        The underlying OCC topological edge data structure.
     adaptor : ``BRepAdaptor_Curve``
         Edge adaptor for extracting curve geometry.
-    curve : :class:`compas_occ.geometry.OCCCurve`
-        Curve geometry from the edge adaptor.
 
     """
 
@@ -163,7 +166,7 @@ def to_line(self) -> compas.geometry.Line:
 
         Returns
         -------
-        :class:`compas.geometry.Line`
+        :class:`~compas.geometry.Line`
             A COMPAS line.
 
         Raises
@@ -184,7 +187,7 @@ def to_circle(self) -> compas.geometry.Circle:
 
         Returns
         -------
-        :class:`compas.geometry.Circle`
+        :class:`~compas.geometry.Circle`
             A COMPAS circle.
 
         Raises
@@ -210,7 +213,7 @@ def to_ellipse(self) -> compas.geometry.Ellipse:
 
         Returns
         -------
-        :class:`compas.geometry.Ellipse`
+        :class:`~compas.geometry.Ellipse`
             A COMPAS ellipse.
 
         Raises
@@ -305,7 +308,7 @@ def to_curve(self) -> Curve:
 
         Returns
         -------
-        :class:`compas_occ.geometry.Curve`
+        :class:`~compas_occ.geometry.Curve`
 
         """
         return self.curve

src/compas_occ/brep/brepface.py

@@ -22,24 +22,27 @@ class BRepFace:
 
     Parameters
     ----------
-    face : TopoDS_Face
+    face : ``TopoDS_Face``
         An OCC BRep face.
 
     Attributes
     ----------
-    face : TopoDS_Face
-        The OCC BRep face.
-    vertices : list[:class:`compas_occ.brep.BRepVertex`], read-only
+    vertices : list[:class:`~compas_occ.brep.BRepVertex`], read-only
         List of BRep vertices.
-    edges : list[:class:`compas_occ.brep.BRepEdge`], read-only
+    edges : list[:class:`~compas_occ.brep.BRepEdge`], read-only
         List of BRep edges.
-    loops : list[:class:`compas_occ.brep.BRepLoop`], read-only
+    loops : list[:class:`~compas_occ.brep.BRepLoop`], read-only
         List of BRep loops.
-    adaptor : BRepAdaptor_Surface
-        Adaptor for extracting surface geometry from the BRep face.
-    surface : GeomAdaptor_Surface
+    surface : ``GeomAdaptor_Surface``
         Surface geometry from the adaptor.
 
+    Other Attributes
+    ----------------
+    face : ``TopoDS_Face``
+        The OCC BRep face.
+    adaptor : ``BRepAdaptor_Surface``
+        Adaptor for extracting surface geometry from the BRep face.
+
     """
 
     def __init__(self, face: TopoDS_Face):

src/compas_occ/brep/breploop.py

@@ -13,18 +13,21 @@ class BRepLoop:
 
     Parameters
     ----------
-    loop : TopoDS_Wire
+    loop : ``TopoDS_Wire``
         An OCC BRep wire.
 
     Attributes
     ----------
-    loop : TopoDS_Wire
-        The OCC BRep wire.
-    vertices : list[:class:`compas_occ.brep.BRepVertex`], read-only
+    vertices : list[:class:`~compas_occ.brep.BRepVertex`], read-only
         List of BRep vertices.
-    edges : list[:class:`compas_occ.brep.BRepEdge`], read-only
+    edges : list[:class:`~compas_occ.brep.BRepEdge`], read-only
         List of BRep edges.
 
+    Other Attributes
+    ----------------
+    loop : ``TopoDS_Wire``
+        The OCC BRep wire.
+
     """
 
     def __init__(self, loop: TopoDS_Wire):

src/compas_occ/brep/brepvertex.py

@@ -17,10 +17,13 @@ class BRepVertex:
 
     Attributes
     ----------
+    point : :class:`~compas.geometry.Point`, read-only
+        The geometric point underlying the topological vertex.
+
+    Other Attributes
+    ----------------
     vertex : ``TopoDS_Vertex``
         The underlying OCC vertex.
-    point : :class:`compas.geometry.Point`, read-only
-        The geometric point underlying the topological vertex.
 
     """
 

src/compas_occ/conversions/arrays.py

@@ -16,7 +16,7 @@ def array1_from_points1(points: List[Point]) -> TColgp_Array1OfPnt:
 
     Parameters
     ----------
-    points : list[:class:`compas.geometry.Point`]
+    points : list[:class:`~compas.geometry.Point`]
 
     Returns
     -------
@@ -34,7 +34,7 @@ def harray1_from_points1(points: List[Point]) -> TColgp_HArray1OfPnt:
 
     Parameters
     ----------
-    points : list[:class:`compas.geometry.Point`]
+    points : list[:class:`~compas.geometry.Point`]
 
     Returns
     -------
@@ -56,7 +56,7 @@ def points1_from_array1(array: TColgp_Array1OfPnt) -> List[Point]:
 
     Returns
     -------
-    list[:class:`compas.geometry.Point`]
+    list[:class:`~compas.geometry.Point`]
 
     """
     return [Point(point.X(), point.Y(), point.Z()) for point in array]
@@ -67,7 +67,7 @@ def array2_from_points2(points: List[List[Point]]) -> TColgp_Array2OfPnt:
 
     Parameters
     ----------
-    points : list[list[:class:`compas.geometry.Point`]]
+    points : list[list[:class:`~compas.geometry.Point`]]
 
     Returns
     -------
@@ -93,7 +93,7 @@ def points2_from_array2(array: TColgp_Array2OfPnt) -> List[List[Point]]:
 
     Returns
     -------
-    list[list[:class:`compas.geometry.Point`]]
+    list[list[:class:`~compas.geometry.Point`]]
 
     """
     points = [[None for j in range(array.NbRows())] for i in range(array.NbColumns())]

src/compas_occ/conversions/meshes.py

@@ -113,7 +113,7 @@ def compas_trimesh_to_occ_shell(mesh: Mesh) -> TopoDS_Shell:
 
     Parameters
     ----------
-    mesh : :class:`compas.datastructures.Mesh`
+    mesh : :class:`~compas.datastructures.Mesh`
         A COMPAS mesh data structure with triangle faces.
 
     Returns
@@ -144,7 +144,7 @@ def compas_quadmesh_to_occ_shell(mesh: Mesh) -> TopoDS_Shell:
 
     Parameters
     ----------
-    mesh : :class:`compas.datastructures.Mesh`
+    mesh : :class:`~compas.datastructures.Mesh`
         A COMPAS mesh data structure with quad faces.
 
     Returns
@@ -175,7 +175,7 @@ def compas_mesh_to_occ_shell(mesh: Mesh) -> TopoDS_Shell:
 
     Parameters
     ----------
-    mesh : :class:`compas.datastructures.Mesh`
+    mesh : :class:`~compas.datastructures.Mesh`
         A COMPAS mesh data structure.
 
     Returns