]> SALOME platform Git repositories - modules/shaper.git/blobdiff - src/SketchPlugin/doc/radiusFeature.rst
Salome HOME
Correct documentation bugs, adapt for 'Read The Docs' theme (bos #18858)
[modules/shaper.git] / src / SketchPlugin / doc / radiusFeature.rst
index 561a597e2b17c22c5dfcc955689d803138a36975..38b2b280b1ec5693f2c227c0759c40144f8a246d 100644 (file)
@@ -1,3 +1,4 @@
+.. |radius_constr.icon|    image:: images/radius_constr.png
 
 Radius constraint
 =================
 
 Radius constraint
 =================
@@ -7,35 +8,24 @@ Radius constraint fixes the radius of circle or arc.
 To create a Radius constraint in the active Sketch:
 
 #. select in the Main Menu *Sketch - > Radius* item  or
 To create a Radius constraint in the active Sketch:
 
 #. select in the Main Menu *Sketch - > Radius* item  or
-#. click **Radius** button in Sketch toolbar:
-
-.. image:: images/radius_constr.png
-   :align: center
-
-.. centered::
-   **Radius**  button
+#. click |radius_constr.icon| **Radius** button in Sketch toolbar:
 
 Property panel:
 
 .. image:: images/Radius_panel.png
    :align: center
 
 Property panel:
 
 .. image:: images/Radius_panel.png
    :align: center
+.. |loc_left| image:: images/location_left.png
+.. |loc_auto| image:: images/location_automatic.png
+.. |loc_right| image:: images/location_right.png
 
 Input fields:
 
 - **Circle or Arc** is the circle or arc selected in the view; 
 - **Value** is a radius of the selected object, could be modified to set the desirable value
 - **Text location** is a position of the radius value label relating to extension line (in the view)
 
 Input fields:
 
 - **Circle or Arc** is the circle or arc selected in the view; 
 - **Value** is a radius of the selected object, could be modified to set the desirable value
 - **Text location** is a position of the radius value label relating to extension line (in the view)
-   .. image:: images/location_left.png
-      :align: left
-   **Left** inserts text at the left of the radius extension line.
-
-   .. image:: images/location_automatic.png
-      :align: left
-   **Automatic** inserts text at the middle of the radius extension line if it has enough length, otherwise - to the left.
-
-   .. image:: images/location_right.png
-      :align: left
-   **Right** inserts text to the right of the radius extension line.
+   | |loc_left| **Left** inserts text at the left of the radius extension line.
+   | |loc_auto| **Automatic** inserts text at the middle of the radius extension line if it has enough length, otherwise - to the left.
+   | |loc_right| **Right** inserts text to the right of the radius extension line.
 
 When circle or arc is selected, the radius value is displayed in the property panel and in the view.
 
 
 When circle or arc is selected, the radius value is displayed in the property panel and in the view.
 
@@ -50,9 +40,13 @@ When creating the constraint, after selection of the circle or arc at the first
 .. centered::
    Radius input in the view
 
 .. centered::
    Radius input in the view
 
-**TUI Command**: *Sketch_1.setRadius(CircleOrArc, Value)*
+**TUI Command**:
+
+.. py:function:: Sketch_1.setRadius(CircleOrArc, Value)
 
 
-**Arguments**:  circle or arc circumference object + radius value
+    :param object: Circle or arc.
+    :param real: Radius.
+    :return: Result object.
 
 Result
 """"""
 
 Result
 """"""