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

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

diff --git a/src/BuildPlugin/doc/compsolidFeature.rst b/src/BuildPlugin/doc/compsolidFeature.rst
index d33fb9c218d841ba6c8a7c1900faecdcb5512c39..5f5c3feb630c892eb41e8ff16344ac71a15d5a47 100644 (file)
--- a/src/BuildPlugin/doc/compsolidFeature.rst
+++ b/src/BuildPlugin/doc/compsolidFeature.rst
@@ -1,3 +1,4 @@
+.. |feature_compsolid.icon|    image:: images/feature_compsolid.png
 
 CompSolid
 =========
@@ -7,20 +8,13 @@ Compsolid feature creates a compsolid using shapes already existing in other obj
 To create a compsolid in the active part:
 
 #. select in the Main Menu *Build - > CompSolid* item  or
-#. click **CompSolid** button in the toolbar
-
-.. image:: images/feature_compsolid.png
-  :align: center
-
-.. centered::
-  **CompSolid** button
+#. click |feature_compsolid.icon| **CompSolid** button in the toolbar
 
 The following property panel will be opened:
 
-.. image:: images/Compsolid.png
+.. figure:: images/Compsolid.png
   :align: center
 
-.. centered::
   Create a compsolid
 
 Select one or several shapes in the viewer.
@@ -29,19 +23,22 @@ Select one or several shapes in the viewer.
 
 **Cancel** button cancels the operation. 
 
-**TUI Command**:  *model.addCompSolid(Part_doc, Shapes)*
+**TUI Command**:
+
+.. py:function:: model.addCompSolid(Part_doc, Shapes)
 
-**Arguments**:   Part document + list of shapes.
+    :param part: The current part object.
+    :param list: A list of shapes.
+    :return: Result object.
 
 Result
 """"""
 
 The result of the operation will be a compsolid created from the selected shapes:
 
-.. image:: images/CreateCompsolid.png
+.. figure:: images/CreateCompsolid.png
   :align: center
 
-.. centered::
   Result of the operation.
 
 **See Also** a sample TUI Script of :ref:`tui_create_compsolid` operation.