Documentation: use 'figure' instead of 'image'; improve caption layout; fix warnings.

[modules/shaper.git] / src / FeaturesPlugin / doc / recoverFeature.rst

diff --git a/src/FeaturesPlugin/doc/recoverFeature.rst b/src/FeaturesPlugin/doc/recoverFeature.rst
index 18ae83f59d68a0675b951833df75adf60cb54f0f..c2cc6d22ce4fbdf76cef85ad33db519af5914a51 100644 (file)
--- a/src/FeaturesPlugin/doc/recoverFeature.rst
+++ b/src/FeaturesPlugin/doc/recoverFeature.rst
@@ -1,3 +1,5 @@
+.. |recover.icon|    image:: images/recover.png
+
 Recover
 =======
 
@@ -6,50 +8,52 @@ Recover
 To recover in the active part:
 
 #. select in the Main Menu *Features - > Recover* item or
-#. click **Recover** button in the toolbar
-
-.. image:: images/recover.png
-   :align: center
-
-.. centered::
-   **Recover** button
+#. click |recover.icon| **Recover** button in the toolbar
 
 The feature has the following options:
 
-.. image:: images/recover_default_32x32.png
+.. figure:: images/recover_default_32x32.png
    :align: left
+   :height: 24px
+
 restore only the objects used in the operation
 
-.. image:: images/recover_compound_32x32.png
+.. figure:: images/recover_compound_32x32.png
    :align: left
+   :height: 24px
+
 restore full compound/compsolid if the operation used one or more of its sub-shapes
 
+--------------------------------------------------------------------------------
 
 Recover objects
 ---------------
 
-.. image:: images/recover_mode_default.png
+.. figure:: images/recover_mode_default.png
    :align: center
 
-.. centered::
    Recover objects used in operation
 
 - **Feature** field contains one of the previous operations;
 - **List of recovered** objects contains all the shapes used in the operation. Need to enable checkbox to restore a shape.
 
-**TUI Command**: *model.addRecover(Part_doc, feature, [recovering_results])*
+**TUI Command**:
 
-**Arguments**: part + the name of the feature + list of results used in the feature.
+.. py:function:: model.addRecover(Part_doc, feature, [recovering_results])
+
+    :param part: The current part object.
+    :param string: The name of the feature.
+    :param list: A list of results used in the feature.
+    :return: Created object.
 
 Result
 """"""
 
 Result of restoring the shape used in Split operation in compsolid is a single solid.
 
-.. image:: images/recover_res_default.png
+.. figure:: images/recover_res_default.png
    :align: center
 
-.. centered::
    Recover a solid
 
 **See also** a sample TUI script of ref:`tui_recover_default` operation.
@@ -58,28 +62,32 @@ Result of restoring the shape used in Split operation in compsolid is a single s
 Recover top-level objects
 -------------------------
 
-.. image:: images/recover_mode_compound.png
+.. figure:: images/recover_mode_compound.png
    :align: center
 
-.. centered::
    Recover top-level compounds/compsolids of objects used in operation
 
 - **Feature** field contains one of the previous operations;
 - **List of recovered** objects contains all top-level shapes (compounds/compsolids) of the shapes used in the operation. Need to enable checkbox to restore a shape.
 
-**TUI Command**: *model.addRecover(Part_doc, feature, [recovering_results], True)*
+**TUI Command**:
+
+.. py:function:: model.addRecover(Part_doc, feature, [recovering_results], True)
 
-**Arguments**: part + the name of the feature + list of results used in the feature + *True* to specify restoring compounds.
+    :param part: The current part object.
+    :param string: The name of the feature.
+    :param list: A list of results used in the feature.
+    :param boolean: *True* to specify restoring compounds.
+    :return: Created object.
 
 Result
 """"""
 
 Result of restoring the shape used in Split operation in compsolid is a full compsolid.
 
-.. image:: images/recover_res_compound.png
+.. figure:: images/recover_res_compound.png
    :align: center
 
-.. centered::
    Recover a compsolid
 
 **See also** a sample TUI script of ref:`tui_recover_compound` operation.