Correct documentation bugs, adapt for 'Read The Docs' theme (bos #18858)

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

diff --git a/src/FeaturesPlugin/doc/pipeFeature.rst b/src/FeaturesPlugin/doc/pipeFeature.rst
index fd26614b9d7df807908bbb6cbbb96b00c931c82f..1f9924580b7550fb19b8992ccdf06ecb0e5102e5 100644 (file)
--- a/src/FeaturesPlugin/doc/pipeFeature.rst
+++ b/src/FeaturesPlugin/doc/pipeFeature.rst
@@ -1,3 +1,4 @@
+.. |pipe.icon|    image:: images/pipe.png
 
 Pipe
 ====
@@ -7,27 +8,29 @@ Pipe
 To create a Pipe in the active part:
 
 #. select in the Main Menu *Features - > Pipe* item  or
-#. click **Pipe** button in the toolbar
+#. click |pipe.icon| **Pipe** button in the toolbar
 
-.. image:: images/pipe.png        
-   :align: center
+Pipe can be created in three different ways:
 
-.. centered::
-   **Pipe** button 
+.. image:: images/pipe_simple_32x32.png    
+   :align: left
+   :height: 24px
 
-Pipe can be created in three different ways:
+by object and path 
+
+.. image:: images/pipe_binormal_32x32.png      
+   :align: left
+   :height: 24px
 
-  .. image:: images/pipe_simple_32x32.png    
-    :align: left
-  by object and path 
+by object, path and Bi-normal  
 
-  .. image:: images/pipe_binormal_32x32.png      
-    :align: left
-  by object, path and Bi-normal  
+.. image:: images/pipe_locations_32x32.png    
+   :align: left
+   :height: 24px
 
-  .. image:: images/pipe_locations_32x32.png    
-    :align: left
-  by object, path and locations 
+by object, path and locations 
+
+--------------------------------------------------------------------------------
 
 Pipe by object and path
 -----------------------
@@ -45,9 +48,14 @@ Input fields:
 - **Base objects** panel contains shapes to be extruded. Several Base Objects generate several pipes. Shapes (edges, faces, shells) are selected in 3D OCC viewer or object browser;
 - **Path object**  defines the path along which the Base Object will be extruded.  **Path object** (edge or wire) is selected in 3D OCC viewer or object browser;
 
-**TUI Command**:  *model.addPipe(Part_doc, [shape], path)*
+**TUI Command**:
+
+.. py:function:: model.addPipe(Part_doc, [shape], path)
  
-**Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + path in format *model.selection(TYPE, shape)*.
+    :param part: The current part object.
+    :param list: A list of shapes in format *model.selection(TYPE, shape)*.
+    :param object: A path in format *model.selection(TYPE, shape)*.
+    :return: Created object.
 
 Result
 """"""
@@ -79,9 +87,15 @@ Input fields:
 - **Path object**  defines the path along which the Base Object will be extruded.  **Path object** (edge or wire) is selected in 3D OCC viewer or object browser;
 - **Bi-Normal** defines the BiNormal Vector. **Bi-Normal** (edge or wire) is selected in 3D OCC viewer or object browser.
 
-**TUI Command**:  *model.addPipe(Part_doc, [shape], path, binormal)*
+**TUI Command**:
+
+.. py:function:: model.addPipe(Part_doc, [shape], path, binormal)
  
-**Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + path in format *model.selection(TYPE, shape)* + binormal in format *model.selection(TYPE, shape)*.
+    :param part: The current part object.
+    :param list: A list of shapes in format *model.selection(TYPE, shape)*.
+    :param object: A path in format *model.selection(TYPE, shape)*.
+    :param object: A binormal in format *model.selection(TYPE, shape)*.
+    :return: Created object.
 
 Result
 """"""
@@ -113,9 +127,15 @@ Input fields:
 - **Path object**  defines the path along which the Base Object will be extruded.  **Path object** (edge or wire) is selected in 3D OCC viewer or object browser;
 - **Locations** define the list of vertices that specify the locations of extruded Base Objects on the resulting Path Object. The number of Base Objects should be equal to the number of Locations.
 
-**TUI Command**:  *model.addPipe(Part_doc, [shape], path, locations)*
+**TUI Command**:
+
+.. py:function:: model.addPipe(Part_doc, [shape], path, locations)
  
-**Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + path in format *model.selection(TYPE, shape)* + list of locations in format *model.selection(TYPE, shape)*.
+    :param part: The current part object.
+    :param list: A list of shapes in format *model.selection(TYPE, shape)*.
+    :param object: A path in format *model.selection(TYPE, shape)*.
+    :param list: A list of locations in format *model.selection(TYPE, shape)*.
+    :return: Created object.
 
 Result
 """"""
@@ -128,4 +148,4 @@ Result of extrusion of 3 circles along arc with specified locations.
 .. centered::
    Pipe by object, path and locations
 
-**See Also** a sample TUI Script of :ref:`tui_locations_pipe` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_locations_pipe` operation.