Merge remote-tracking branch 'remotes/origin/vsr/18858'

[modules/shaper.git] / src / BuildPlugin / doc / subShapesFeature.rst

diff --git a/src/BuildPlugin/doc/subShapesFeature.rst b/src/BuildPlugin/doc/subShapesFeature.rst
index d1b767232f6dab1cfe15b35dcf05f02d38af885c..6bf463bff29caffa0d39456b789592ac085d86ee 100644 (file)
--- a/src/BuildPlugin/doc/subShapesFeature.rst
+++ b/src/BuildPlugin/doc/subShapesFeature.rst
@@ -1,3 +1,4 @@
+.. |feature_subshapes.icon|    image:: images/feature_subshapes.png
 
 Sub-shapes
 ==========
@@ -10,20 +11,13 @@ The feature **Sub-shapes** modifies the selected entity by creating a non-manifo
 To create Sub-shapes in the active part:
 
 #. select in the Main Menu *Build - > Sub-shapes* item  or
-#. click **Sub-shapes** button in the toolbar
-
-.. image:: images/feature_subshapes.png 
-   :align: center
-
-.. centered::
-   **Sub-shapes** button 
+#. click |feature_subshapes.icon| **Sub-shapes** button in the toolbar
 
 The following property panel appears.
 
-.. image:: images/SubShapes.png
+.. figure:: images/SubShapes.png
   :align: center
 
-.. centered::
   Sub-shapes property panel
 
 Input fields:
@@ -31,18 +25,22 @@ Input fields:
 - **Shape** panel contains the shape to be modified. The shape is selected in 3D OCC viewer or object browser. For today it has to be a wire or a face;
 - **Sub-shapes** panel contains the list of sub-shapes which are already included into result. A sub-shape can be deleted from the list or the list can be extended with new shapes selected in the view.
 
-**TUI Command**:  *model.addSubShapes(Part_doc, shape, sub-shapes)*
+**TUI Command**:
+
+.. py:function:: model.addSubShapes(Part_doc, shape, sub-shapes)
 
-**Arguments**: 1 part + shape in format *model.selection(TYPE, shape)* + list of sub-shapes in format *model.selection(TYPE, subshape)*.
+    :param part: The current part object.
+    :param object: A shape in format *model.selection(TYPE, shape)*.
+    :param list: A list of sub-shapes in format *model.selection(TYPE, subshape)*.
+    :return: Result object.
 
 Result
 """"""
 The result replaces the original shape with its copy with added/removed sub-shapes.
 
-.. image:: images/CreateSubShapes.png
+.. figure:: images/CreateSubShapes.png
    :align: center
 
-.. centered::
    Sub-shapes
 
 **See Also** a sample TUI Script of :ref:`tui_create_subshape` operation.