From 1087e961cab2a71436cfd8eaf84d424a41a8c1cc Mon Sep 17 00:00:00 2001 From: Joachim Schoeberl Date: Tue, 7 Sep 2021 16:28:39 +0200 Subject: [PATCH] more docsstrings --- libsrc/occ/python_occ_shapes.cpp | 7 ++++--- python/occ.py | 11 +++++++++++ 2 files changed, 15 insertions(+), 3 deletions(-) diff --git a/libsrc/occ/python_occ_shapes.cpp b/libsrc/occ/python_occ_shapes.cpp index 4c712c9b..64ce4883 100644 --- a/libsrc/occ/python_occ_shapes.cpp +++ b/libsrc/occ/python_occ_shapes.cpp @@ -1836,9 +1836,10 @@ DLL_HEADER void ExportNgOCCShapes(py::module &m) aTool.AddWire(TopoDS::Wire(shape)); aTool.CheckCompatibility(Standard_False); return aTool.Shape(); - }, py::arg("wires"), py::arg("solid")=true); - - + }, py::arg("wires"), py::arg("solid")=true, + "Building a loft. This is a shell or solid passing through a set of sections (wires). " + "First and last sections may be vertices. See https://dev.opencascade.org/doc/refman/html/class_b_rep_offset_a_p_i___thru_sections.html#details"); + py::class_> (m, "WorkPlane") .def(py::init(), py::arg("axes")=gp_Ax3(), py::arg("pos")=gp_Ax2d()) diff --git a/python/occ.py b/python/occ.py index 39f9e811..0e94898e 100644 --- a/python/occ.py +++ b/python/occ.py @@ -1,3 +1,14 @@ +""" Netgen OCC documentation + +This module provides the Netgen OCCGeometry class, as well as Python wrappers +for OpenCascade functionality. This allows the construction from scratch, as well as +editing geometries imported via STEP format. + +Most of the classes are directly py-wrapped from the OCCT classes. +For more detailed documentation consult the OCCT docs, a good starting point is +https://dev.opencascade.org/doc/refman/html/class_b_rep_builder_a_p_i___make_shape.html +""" + from .libngpy._NgOCC import * from .meshing import meshsize