From: mzn Date: Fri, 28 Sep 2018 11:42:47 +0000 (+0300) Subject: Add tutorial help page. X-Git-Tag: CEA_2018-2~53 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=b73fb7468bea81901dbeed8e229d742f788ec282;p=modules%2Fshaper.git Add tutorial help page. --- diff --git a/doc/gui/CMakeLists.txt b/doc/gui/CMakeLists.txt index abdaa6c81..27f10eb91 100644 --- a/doc/gui/CMakeLists.txt +++ b/doc/gui/CMakeLists.txt @@ -24,6 +24,8 @@ SET(output ${CMAKE_CURRENT_BINARY_DIR}/conf.py) SET(DOC_FILES Introduction.rst + Tutorial.rst + TUI_tutorial.rst ) CONFIGURE_FILE(${input} ${output}) diff --git a/doc/gui/TUI_tutorial.rst b/doc/gui/TUI_tutorial.rst new file mode 100644 index 000000000..8a09c1ff1 --- /dev/null +++ b/doc/gui/TUI_tutorial.rst @@ -0,0 +1,10 @@ + .. _tui_tutorial: + +Tutorial TUI Script +=================== + +.. literalinclude:: examples/tutorial.py + :linenos: + :language: python + +:download:`Download this script ` \ No newline at end of file diff --git a/doc/gui/Tutorial.rst b/doc/gui/Tutorial.rst new file mode 100644 index 000000000..679b432f1 --- /dev/null +++ b/doc/gui/Tutorial.rst @@ -0,0 +1,320 @@ + +.. _tutorial: + + +Tutorial +======== + +This exercise illustrates how to create screw-nut shape from scratch. + + +Step1. Sketch. +-------------- + +At this step we will create a regular hexagon. + +- Create a :ref:`new-part` via Main Menu *Part - > New part* +- Start :ref:`Sketch ` creation via Main Menu *Sketch - > Sketch* +- Set **Size of the view** parameter equal to 250 in the Sketch dialog +- Select **XOY** plane in the view +- Click **Set plane view** button in the Sketch property panel + +.. image:: images/tutorial1_1.png + :align: center + +.. centered:: + Skecth plane XOY +- Start :ref:`Line ` creation via Main Menu *Sketch - > Line* +- Pick 3 points in the view one by one and select the first one at the end to get a triangle: + +.. image:: images/tutorial1_2.png + :align: center + +.. centered:: + 3 Lines forming a triangle +- Hide trihedron via **Show/Hide trihedron** button in viewer toolbar +- Select **Origin** object from **Part set / Constructions** folder in the object browser +- Click on the eye icon on the left of the origin item to show it in the view +- Select both origin and the bottom vertex of the triangle in the view (use **Shift** key for multi-selection) + +.. image:: images/tutorial1_3.png + :align: center + +.. centered:: + Origin and triangle +- Create :ref:`Coincident ` constraint via **Coincident** button in Sketch toolbar +.. image:: images/tutorial1_4.png + :align: center + +.. centered:: + Triangle vertex coincident with origin +- Show trihedron +- Select both **OY** axis and the upper side of the triangle in the view +- Create :ref:`Perpendicular ` constraint via **Pependicular** button in Sketch toolbar +.. image:: images/tutorial1_5.png + :align: center + +.. centered:: + Upper triangle side perpendicular to OY axis +- Select the left and the upper side of the triangle +- Create :ref:`Equal ` constraint via **Equal** button in Sketch toolbar +- Make the upper and the right sides equal length in the same way +.. image:: images/tutorial1_6.png + :align: center + +.. centered:: + Equilateral triangle +- Select the left side of the triangle +- Check **Auxiliary** check box in the property panel and click **Apply** button +.. image:: images/tutorial1_7.png + :align: center + +.. centered:: + Line property panel +- Make the right side auxiliary in the same way +.. image:: images/tutorial1_8.png + :align: center + +.. centered:: + The lateral sides are auxiliary +- Start creation of :ref:`Angular copy ` feature via **Angular copy** button in Sketch toolbar +- Select the upper side of the triangle for **Segments** parameter in the property panel +- Select origin in the view as a center of rotation +- Set **Total number** of objects equal to 6 +.. image:: images/tutorial1_9.png + :align: center + +.. centered:: + Angular copy parameters +- Click **Apply** button +.. image:: images/tutorial1_10.png + :align: center + +.. centered:: + Regular hexagon +- Select the upper side of the hexagon +- Start creation of :ref:`Length ` constraint via **Length** button in Sketch toolbar +- Set length value equal to 115.4 and press **Enter** +.. image:: images/tutorial1_11.png + :align: center + +.. centered:: + Fully fixed regular hexagon +- Click **Apply** button in the *Skecth* property panel to finish the sketch creation +.. image:: images/tutorial1_12.png + :align: center + +.. centered:: + Finished Sketch + +Step2. Polyline. +---------------- + +- Start :ref:`Point ` creation via Main Menu *Construction - > Point* +- Set x = 50, y = 0, z = 0 +.. image:: images/tutorial2_1.png + :align: center + +.. centered:: + Construction of point (50, 0, 0) +- Click **Apply** button to finish point creation +- Create points (80, 0, 0), (112, 0, 13), (112, 0, 48), (80, 0, 63), (80, 0, 90), (50, 0, 90) in the same way +- Select the created points in the object browser under **Part_1 / Constructions** node +- Click right mouse button and select **Color...** item in the popup menu +- Select blue color and click **OK** button +.. image:: images/tutorial2_2.png + :align: center + +.. centered:: + Points created from scratch +- Start :ref:`Polyline ` creation via Main Menu *Build - > Polyline* +- Select all the 7 points (use **Shift** key for multi-selection) +- Check **Closed** check box +.. image:: images/tutorial2_3.png + :align: center + +.. centered:: + Creation of closed polyline from 7 points +- Click **Apply** button in the property panel +.. image:: images/tutorial2_4.png + :align: center + +.. centered:: + Closed Polyline + +Step3. Face. +------------ + +- Start :ref:`Face ` creation via Main Menu *Build - > Face* +- Select **Polyline_1_1** in the object browser under **Part_1 / Results** node +.. image:: images/tutorial3_1.png + :align: center + +.. centered:: + Construction of face from a polyline +- Click **Apply** button in the property panel +.. image:: images/tutorial3_2.png + :align: center + +.. centered:: + Face + +Step4. Revolution. +------------------ + +- Start :ref:`Revolution ` creation via Main Menu *Features - > Revolution* +- Select the face created at step 3 in the view +- Click on axis input field in the property panel and select **OZ** axis in the view +.. image:: images/tutorial4_1.png + :align: center + +.. centered:: + Revolution around OZ by 360 degrees +- Click **Apply** button in the property panel +.. image:: images/tutorial4_2.png + :align: center + +.. centered:: + Solid created by rotation of face + +Step5. Extrusion. +----------------- + +- Start :ref:`Extrusion ` creation via Main Menu *Features - > Extrusion* +- Select the hexagon created at step 1 +- Click on axis input field in the property panel and select **OZ** axis in the view +- Set **To size** parameter equal to 100 +.. image:: images/tutorial5_1.png + :align: center + +.. centered:: + Extrusion along OZ axis from 0 to 100 +- Click **Apply** button in the property panel +.. image:: images/tutorial5_2.png + :align: center + +.. centered:: + Solid created by extrusion of sketch + +Step6. Common. +-------------- + +- Start :ref:`Common ` creation via Main Menu *Features - > Common* +- Select the extrusion and the revolution in the object browser under **Part_1 / Results** node (use **Shift** key for multi-selection) +.. image:: images/tutorial6_1.png + :align: center + +.. centered:: + Common creation +- Click **Apply** button in the property panel +.. image:: images/tutorial6_2.png + :align: center + +.. centered:: + The revolution and the extrusion common part + +Step7. Fillet. +-------------- + +- Start :ref:`Fillet ` creation via Main Menu *Features - > Fillet* +- Select the edge +.. image:: images/tutorial7_1.png + :align: center + +.. centered:: + Select edge for a Fillet +- Select **Radius** parameter equal to 10 +.. image:: images/tutorial7_2.png + :align: center + +.. centered:: + Fillet with radius = 10 +- Click **Apply** button in the property panel +.. image:: images/tutorial7_3.png + :align: center + +.. centered:: + Fillet + +Step8. Box. +----------- + +- Click right mouse button in the view and select **Hide all** item in the popup menu to clear the view +- Start :ref:`Box ` creation via Main Menu *Primitives - > Box* +- Set **DX** = 10, **DY** = 120, **DZ** = 20 +.. image:: images/tutorial8_1.png + :align: center + +.. centered:: + Box creation +- Click **Apply** button in the property panel +.. image:: images/tutorial8_2.png + :align: center + +.. centered:: + Box + +Step9. Translation. +------------------- + +- Start :ref:`Translation ` creation via Main Menu *Part - > Translation* +- Check **By X, Y and Z dimensions** option on the top of the property panel +- Select the box in the view +- Set **DX** = -10, **DY** = 20, **DZ** = 70 +.. image:: images/tutorial9_1.png + :align: center + +.. centered:: + Box translation +- Click **Apply** button in the property panel +.. image:: images/tutorial9_2.png + :align: center + +.. centered:: + Translated Box + +Step10. Angular Copy. +--------------------- + +- Start :ref:`Angular Copy ` creation via Main Menu *Part - > Angular Copy* +- Select the box in the view +- Click on axis input field in the property panel and select **OZ** axis in the view +- Set **Nb copies** parameter equal to 6 +.. image:: images/tutorial10_1.png + :align: center + +.. centered:: + Angular Copy around OZ +- Click **Apply** button in the property panel +.. image:: images/tutorial10_2.png + :align: center + +.. centered:: + Copied Box + +Step11. Cut. +------------ + +- Select **Fillet_1_1** item in the object browser under **Part_1 / Results** node +- Click on the eye icon on the left of the result item to show it in the view +- Start :ref:`Cut ` creation via Main Menu *Features - > Cut* +- Select the fillet object in the view as a main object +- Select the angular copy object in the object browser as a tool object +.. image:: images/tutorial11_1.png + :align: center + +.. centered:: + Cut creation +- Click **Apply** button in the property panel +- Select the created **Cut_1_1** item in the object browser under **Part_1 / Results** node +- Click right mouse button and select **Color...** item in the popup menu +- Set (R: 255, G: 214, B: 0) color and click **OK** button + +.. image:: images/tutorial11_2.png + :align: center + +.. centered:: + Cut + + +**See Also** a :ref:`TUI Script ` reproducing all the tutorial steps. \ No newline at end of file diff --git a/doc/gui/examples/tutorial.py b/doc/gui/examples/tutorial.py new file mode 100644 index 000000000..d6519c9ea --- /dev/null +++ b/doc/gui/examples/tutorial.py @@ -0,0 +1,87 @@ +# -*- coding: utf-8 -*- + +from SketchAPI import * + +from salome.shaper import model + +model.begin() +partSet = model.moduleDocument() +Part_1 = model.addPart(partSet) +Part_1_doc = Part_1.document() + +# Step1. Sketch. +Sketch_1 = model.addSketch(Part_1_doc, model.defaultPlane("XOY")) +SketchLine_1 = Sketch_1.addLine(-57.7, 99.93933159672423, 57.7, 99.93933159672423) +SketchLine_2 = Sketch_1.addLine(57.7, 99.93933159672423, 0, 0) +SketchLine_2.setAuxiliary(True) +SketchConstraintCoincidence_1 = Sketch_1.setCoincident(SketchLine_1.endPoint(), SketchLine_2.startPoint()) +SketchLine_3 = Sketch_1.addLine(0, 0, -57.7, 99.93933159672423) +SketchLine_3.setAuxiliary(True) +SketchConstraintCoincidence_2 = Sketch_1.setCoincident(SketchLine_2.endPoint(), SketchLine_3.startPoint()) +SketchConstraintCoincidence_3 = Sketch_1.setCoincident(SketchLine_1.startPoint(), SketchLine_3.endPoint()) +SketchProjection_1 = Sketch_1.addProjection(model.selection("VERTEX", "PartSet/Origin"), False) +SketchPoint_1 = SketchProjection_1.createdFeature() +SketchConstraintCoincidence_4 = Sketch_1.setCoincident(SketchLine_3.startPoint(), SketchAPI_Point(SketchPoint_1).coordinates()) +SketchProjection_2 = Sketch_1.addProjection(model.selection("EDGE", "PartSet/OY"), False) +SketchLine_4 = SketchProjection_2.createdFeature() +SketchConstraintPerpendicular_1 = Sketch_1.setPerpendicular(SketchLine_4.result(), SketchLine_1.result()) +SketchConstraintEqual_1 = Sketch_1.setEqual(SketchLine_3.result(), SketchLine_1.result()) +SketchConstraintEqual_2 = Sketch_1.setEqual(SketchLine_2.result(), SketchLine_1.result()) +SketchMultiRotation_1 = Sketch_1.addRotation([SketchLine_1.result()], SketchAPI_Line(SketchLine_4).startPoint(), 360, 6, True) +[SketchLine_5, SketchLine_6, SketchLine_7, SketchLine_8, SketchLine_9] = SketchMultiRotation_1.rotated() +SketchConstraintLength_1 = Sketch_1.setLength(SketchLine_1.result(), 115.4) +model.do() + +# Step2. Polyline. +Point_2 = model.addPoint(Part_1_doc, 50, 0, 0) +Point_2.result().setColor(0, 0, 255) +Point_3 = model.addPoint(Part_1_doc, 80, 0, 0) +Point_3.result().setColor(0, 0, 255) +Point_4 = model.addPoint(Part_1_doc, 112, 0, 13) +Point_4.result().setColor(0, 0, 255) +Point_5 = model.addPoint(Part_1_doc, 112, 0, 48) +Point_5.result().setColor(0, 0, 255) +Point_6 = model.addPoint(Part_1_doc, 80, 0, 63) +Point_6.result().setColor(0, 0, 255) +Point_7 = model.addPoint(Part_1_doc, 80, 0, 90) +Point_7.result().setColor(0, 0, 255) +Point_8 = model.addPoint(Part_1_doc, 50, 0, 90) +Point_8.result().setColor(0, 0, 255) + +Polyline_1_objects = [model.selection("VERTEX", "Point_1"), model.selection("VERTEX", "Point_2"), + model.selection("VERTEX", "Point_3"), model.selection("VERTEX", "Point_4"), + model.selection("VERTEX", "Point_5"), model.selection("VERTEX", "Point_6"), + model.selection("VERTEX", "Point_7")] +Polyline_1 = model.addPolyline3D(Part_1_doc, Polyline_1_objects, True) + +# Step3. Face. +Face_1 = model.addFace(Part_1_doc, [model.selection("WIRE", "Polyline_1_1")]) + +# Step4. Revolution. +Revolution_1 = model.addRevolution(Part_1_doc, [model.selection("FACE", "Face_1_1")], model.selection("EDGE", "PartSet/OZ"), 360, 0) + +# Step5. Extrusion. +Wire_Name = "Sketch_1/Wire-SketchLine_1r-SketchLine_5r-SketchLine_6r-SketchLine_7r-SketchLine_8r-SketchLine_9r" +Extrusion_1 = model.addExtrusion(Part_1_doc, [model.selection("WIRE", Wire_Name)], model.selection("EDGE", "PartSet/OZ"), 100, 0) + +# Step6. Common. +Common_1 = model.addCommon(Part_1_doc, [model.selection("SOLID", "Revolution_1_1"), model.selection("SOLID", "Extrusion_1_1")]) + +# Step7. Fillet. +Fillet_1 = model.addFillet(Part_1_doc, [model.selection("EDGE", "Revolution_1_1/Generated_Face_5&Common_1_1/Modified_Face_10")], 10) + +# Step8. Box. +Box_1 = model.addBox(Part_1_doc, 20, 120, 20) + +# Step9. Translation. +Translation_1 = model.addTranslation(Part_1_doc, [model.selection("SOLID", "Box_1_1")], -10, 20, 70) + +# Step10. Angular Copy. +AngularCopy_1 = model.addMultiRotation(Part_1_doc, [model.selection("SOLID", "Translation_1_1")], model.selection("EDGE", "PartSet/OZ"), 6) + +# Step11. Cut. +Cut_1 = model.addCut(Part_1_doc, [model.selection("SOLID", "Fillet_1_1")], [model.selection("COMPOUND", "AngularCopy_1_1")]) +Cut_1.result().setColor(255, 214, 0) + +model.do() +model.end() diff --git a/doc/gui/images/tutorial10_1.png b/doc/gui/images/tutorial10_1.png new file mode 100644 index 000000000..43e9fedd1 Binary files /dev/null and b/doc/gui/images/tutorial10_1.png differ diff --git a/doc/gui/images/tutorial10_2.png b/doc/gui/images/tutorial10_2.png new file mode 100644 index 000000000..c2bb26d3a Binary files /dev/null and b/doc/gui/images/tutorial10_2.png differ diff --git a/doc/gui/images/tutorial11_1.png b/doc/gui/images/tutorial11_1.png new file mode 100644 index 000000000..05901925b Binary files /dev/null and b/doc/gui/images/tutorial11_1.png differ diff --git a/doc/gui/images/tutorial11_2.png b/doc/gui/images/tutorial11_2.png new file mode 100644 index 000000000..503cbc5cf Binary files /dev/null and b/doc/gui/images/tutorial11_2.png differ diff --git a/doc/gui/images/tutorial1_1.png b/doc/gui/images/tutorial1_1.png new file mode 100644 index 000000000..3959a9a31 Binary files /dev/null and b/doc/gui/images/tutorial1_1.png differ diff --git a/doc/gui/images/tutorial1_10.png b/doc/gui/images/tutorial1_10.png new file mode 100644 index 000000000..bb4c6a8a9 Binary files /dev/null and b/doc/gui/images/tutorial1_10.png differ diff --git a/doc/gui/images/tutorial1_11.png b/doc/gui/images/tutorial1_11.png new file mode 100644 index 000000000..2333c293a Binary files /dev/null and b/doc/gui/images/tutorial1_11.png differ diff --git a/doc/gui/images/tutorial1_12.png b/doc/gui/images/tutorial1_12.png new file mode 100644 index 000000000..02757a860 Binary files /dev/null and b/doc/gui/images/tutorial1_12.png differ diff --git a/doc/gui/images/tutorial1_2.png b/doc/gui/images/tutorial1_2.png new file mode 100644 index 000000000..35b2d03b6 Binary files /dev/null and b/doc/gui/images/tutorial1_2.png differ diff --git a/doc/gui/images/tutorial1_3.png b/doc/gui/images/tutorial1_3.png new file mode 100644 index 000000000..3e03bb823 Binary files /dev/null and b/doc/gui/images/tutorial1_3.png differ diff --git a/doc/gui/images/tutorial1_4.png b/doc/gui/images/tutorial1_4.png new file mode 100644 index 000000000..b722cbddc Binary files /dev/null and b/doc/gui/images/tutorial1_4.png differ diff --git a/doc/gui/images/tutorial1_5.png b/doc/gui/images/tutorial1_5.png new file mode 100644 index 000000000..a0ec10dd6 Binary files /dev/null and b/doc/gui/images/tutorial1_5.png differ diff --git a/doc/gui/images/tutorial1_6.png b/doc/gui/images/tutorial1_6.png new file mode 100644 index 000000000..73b920b1a Binary files /dev/null and b/doc/gui/images/tutorial1_6.png differ diff --git a/doc/gui/images/tutorial1_7.png b/doc/gui/images/tutorial1_7.png new file mode 100644 index 000000000..7be8ac8bf Binary files /dev/null and b/doc/gui/images/tutorial1_7.png differ diff --git a/doc/gui/images/tutorial1_8.png b/doc/gui/images/tutorial1_8.png new file mode 100644 index 000000000..883489e12 Binary files /dev/null and b/doc/gui/images/tutorial1_8.png differ diff --git a/doc/gui/images/tutorial1_9.png b/doc/gui/images/tutorial1_9.png new file mode 100644 index 000000000..67460cfb2 Binary files /dev/null and b/doc/gui/images/tutorial1_9.png differ diff --git a/doc/gui/images/tutorial2_1.png b/doc/gui/images/tutorial2_1.png new file mode 100644 index 000000000..c04a3abbb Binary files /dev/null and b/doc/gui/images/tutorial2_1.png differ diff --git a/doc/gui/images/tutorial2_2.png b/doc/gui/images/tutorial2_2.png new file mode 100644 index 000000000..15a18c20f Binary files /dev/null and b/doc/gui/images/tutorial2_2.png differ diff --git a/doc/gui/images/tutorial2_3.png b/doc/gui/images/tutorial2_3.png new file mode 100644 index 000000000..3bc12cc16 Binary files /dev/null and b/doc/gui/images/tutorial2_3.png differ diff --git a/doc/gui/images/tutorial2_4.png b/doc/gui/images/tutorial2_4.png new file mode 100644 index 000000000..f79018b05 Binary files /dev/null and b/doc/gui/images/tutorial2_4.png differ diff --git a/doc/gui/images/tutorial3_1.png b/doc/gui/images/tutorial3_1.png new file mode 100644 index 000000000..2f6c14e8d Binary files /dev/null and b/doc/gui/images/tutorial3_1.png differ diff --git a/doc/gui/images/tutorial3_2.png b/doc/gui/images/tutorial3_2.png new file mode 100644 index 000000000..39256bb10 Binary files /dev/null and b/doc/gui/images/tutorial3_2.png differ diff --git a/doc/gui/images/tutorial4_1.png b/doc/gui/images/tutorial4_1.png new file mode 100644 index 000000000..54b3d4910 Binary files /dev/null and b/doc/gui/images/tutorial4_1.png differ diff --git a/doc/gui/images/tutorial4_2.png b/doc/gui/images/tutorial4_2.png new file mode 100644 index 000000000..8342c3514 Binary files /dev/null and b/doc/gui/images/tutorial4_2.png differ diff --git a/doc/gui/images/tutorial5_1.png b/doc/gui/images/tutorial5_1.png new file mode 100644 index 000000000..7975c6c27 Binary files /dev/null and b/doc/gui/images/tutorial5_1.png differ diff --git a/doc/gui/images/tutorial5_2.png b/doc/gui/images/tutorial5_2.png new file mode 100644 index 000000000..9fc088869 Binary files /dev/null and b/doc/gui/images/tutorial5_2.png differ diff --git a/doc/gui/images/tutorial6_1.png b/doc/gui/images/tutorial6_1.png new file mode 100644 index 000000000..cbaf2037c Binary files /dev/null and b/doc/gui/images/tutorial6_1.png differ diff --git a/doc/gui/images/tutorial6_2.png b/doc/gui/images/tutorial6_2.png new file mode 100644 index 000000000..11cc51116 Binary files /dev/null and b/doc/gui/images/tutorial6_2.png differ diff --git a/doc/gui/images/tutorial7_1.png b/doc/gui/images/tutorial7_1.png new file mode 100644 index 000000000..3ad2595d1 Binary files /dev/null and b/doc/gui/images/tutorial7_1.png differ diff --git a/doc/gui/images/tutorial7_2.png b/doc/gui/images/tutorial7_2.png new file mode 100644 index 000000000..a655a5477 Binary files /dev/null and b/doc/gui/images/tutorial7_2.png differ diff --git a/doc/gui/images/tutorial7_3.png b/doc/gui/images/tutorial7_3.png new file mode 100644 index 000000000..6e078abf7 Binary files /dev/null and b/doc/gui/images/tutorial7_3.png differ diff --git a/doc/gui/images/tutorial8_1.png b/doc/gui/images/tutorial8_1.png new file mode 100644 index 000000000..eb5bee655 Binary files /dev/null and b/doc/gui/images/tutorial8_1.png differ diff --git a/doc/gui/images/tutorial8_2.png b/doc/gui/images/tutorial8_2.png new file mode 100644 index 000000000..02bf758e4 Binary files /dev/null and b/doc/gui/images/tutorial8_2.png differ diff --git a/doc/gui/images/tutorial9_1.png b/doc/gui/images/tutorial9_1.png new file mode 100644 index 000000000..18ea3a274 Binary files /dev/null and b/doc/gui/images/tutorial9_1.png differ diff --git a/doc/gui/images/tutorial9_2.png b/doc/gui/images/tutorial9_2.png new file mode 100644 index 000000000..028c704a8 Binary files /dev/null and b/doc/gui/images/tutorial9_2.png differ diff --git a/doc/gui/index.rst.in b/doc/gui/index.rst.in index ba442707e..76d491ee1 100644 --- a/doc/gui/index.rst.in +++ b/doc/gui/index.rst.in @@ -7,6 +7,7 @@ Welcome to SHAPER's documentation! ================================== - :ref:`introduction` +- :ref:`tutorial` .. toctree:: :titlesonly: diff --git a/src/BuildPlugin/doc/faceFeature.rst b/src/BuildPlugin/doc/faceFeature.rst index ea1332265..384a3b06b 100644 --- a/src/BuildPlugin/doc/faceFeature.rst +++ b/src/BuildPlugin/doc/faceFeature.rst @@ -1,3 +1,4 @@ +.. _buildFace: Face ==== diff --git a/src/BuildPlugin/doc/polylineFeature.rst b/src/BuildPlugin/doc/polylineFeature.rst index 1e08de4e4..8cff44a70 100644 --- a/src/BuildPlugin/doc/polylineFeature.rst +++ b/src/BuildPlugin/doc/polylineFeature.rst @@ -1,3 +1,4 @@ +.. _buildPolyline: Polyline ======== diff --git a/src/ConstructionPlugin/doc/pointFeature.rst b/src/ConstructionPlugin/doc/pointFeature.rst index caeff7ca5..9d9ec927d 100644 --- a/src/ConstructionPlugin/doc/pointFeature.rst +++ b/src/ConstructionPlugin/doc/pointFeature.rst @@ -1,3 +1,4 @@ +.. _constructionPoint: Point ===== diff --git a/src/FeaturesPlugin/doc/angularCopyFeature.rst b/src/FeaturesPlugin/doc/angularCopyFeature.rst index 4371726b7..c6c5eb047 100644 --- a/src/FeaturesPlugin/doc/angularCopyFeature.rst +++ b/src/FeaturesPlugin/doc/angularCopyFeature.rst @@ -1,3 +1,4 @@ +.. _featureAngularCopy: Angular copy ============ diff --git a/src/FeaturesPlugin/doc/commonFeature.rst b/src/FeaturesPlugin/doc/commonFeature.rst index 7324955eb..e6a7dc763 100644 --- a/src/FeaturesPlugin/doc/commonFeature.rst +++ b/src/FeaturesPlugin/doc/commonFeature.rst @@ -1,3 +1,4 @@ +.. _featureCommon: Common ====== diff --git a/src/FeaturesPlugin/doc/cutFeature.rst b/src/FeaturesPlugin/doc/cutFeature.rst index 053bfa3a8..e5c8bae88 100644 --- a/src/FeaturesPlugin/doc/cutFeature.rst +++ b/src/FeaturesPlugin/doc/cutFeature.rst @@ -1,3 +1,4 @@ +.. _featureCut: Cut === diff --git a/src/FeaturesPlugin/doc/extrusionFeature.rst b/src/FeaturesPlugin/doc/extrusionFeature.rst index 7ba3b93c6..3fdf196be 100644 --- a/src/FeaturesPlugin/doc/extrusionFeature.rst +++ b/src/FeaturesPlugin/doc/extrusionFeature.rst @@ -1,3 +1,4 @@ +.. _featureExtrusion: Extrusion ========= diff --git a/src/FeaturesPlugin/doc/filletFeature.rst b/src/FeaturesPlugin/doc/filletFeature.rst index d30e8da2e..b3d0c89c3 100644 --- a/src/FeaturesPlugin/doc/filletFeature.rst +++ b/src/FeaturesPlugin/doc/filletFeature.rst @@ -1,4 +1,6 @@ +.. _featureFillet: + Fillet ====== diff --git a/src/FeaturesPlugin/doc/revolutionFeature.rst b/src/FeaturesPlugin/doc/revolutionFeature.rst index 648deb89d..ca419aa14 100644 --- a/src/FeaturesPlugin/doc/revolutionFeature.rst +++ b/src/FeaturesPlugin/doc/revolutionFeature.rst @@ -1,3 +1,4 @@ +.. _featureRevolution: Revolution ========== diff --git a/src/FeaturesPlugin/doc/rotationFeature.rst b/src/FeaturesPlugin/doc/rotationFeature.rst index 38bef70b9..a196990eb 100644 --- a/src/FeaturesPlugin/doc/rotationFeature.rst +++ b/src/FeaturesPlugin/doc/rotationFeature.rst @@ -1,3 +1,4 @@ +.. _featureRotation: Rotation ======== diff --git a/src/FeaturesPlugin/doc/translationFeature.rst b/src/FeaturesPlugin/doc/translationFeature.rst index 47099261a..d38c0d760 100644 --- a/src/FeaturesPlugin/doc/translationFeature.rst +++ b/src/FeaturesPlugin/doc/translationFeature.rst @@ -1,3 +1,4 @@ +.. _featureTranslation: Translation =========== diff --git a/src/PartSetPlugin/doc/PartSetPlugin.rst b/src/PartSetPlugin/doc/PartSetPlugin.rst index 70d009b7d..25fcbf7c9 100644 --- a/src/PartSetPlugin/doc/PartSetPlugin.rst +++ b/src/PartSetPlugin/doc/PartSetPlugin.rst @@ -4,6 +4,8 @@ Part plug-in ============ +.. _new-part: + New Part -------- diff --git a/src/SketchPlugin/doc/coincedentFeature.rst b/src/SketchPlugin/doc/coincedentFeature.rst index 68117925a..ef66b0a82 100644 --- a/src/SketchPlugin/doc/coincedentFeature.rst +++ b/src/SketchPlugin/doc/coincedentFeature.rst @@ -1,3 +1,4 @@ +.. _sketchCoincident: Coincident constraint ===================== diff --git a/src/SketchPlugin/doc/equalFeature.rst b/src/SketchPlugin/doc/equalFeature.rst index a36796896..373c977b4 100644 --- a/src/SketchPlugin/doc/equalFeature.rst +++ b/src/SketchPlugin/doc/equalFeature.rst @@ -1,3 +1,4 @@ +.. _sketchEqual: Equal constraint ================ diff --git a/src/SketchPlugin/doc/lengthFeature.rst b/src/SketchPlugin/doc/lengthFeature.rst index c74ec6ccd..c6f720e46 100644 --- a/src/SketchPlugin/doc/lengthFeature.rst +++ b/src/SketchPlugin/doc/lengthFeature.rst @@ -1,3 +1,4 @@ +.. _sketchLength: Length constraint ================= diff --git a/src/SketchPlugin/doc/lineFeature.rst b/src/SketchPlugin/doc/lineFeature.rst index a832a7e13..35207ee96 100644 --- a/src/SketchPlugin/doc/lineFeature.rst +++ b/src/SketchPlugin/doc/lineFeature.rst @@ -1,3 +1,4 @@ +.. _sketchLine: Line ==== diff --git a/src/SketchPlugin/doc/perpendicularFeature.rst b/src/SketchPlugin/doc/perpendicularFeature.rst index a14512206..0a933c7f9 100644 --- a/src/SketchPlugin/doc/perpendicularFeature.rst +++ b/src/SketchPlugin/doc/perpendicularFeature.rst @@ -1,3 +1,4 @@ +.. _sketchPerpendicular: Perpendicular constraint ======================== diff --git a/src/SketchPlugin/doc/rotationFeature.rst b/src/SketchPlugin/doc/rotationFeature.rst index 592417d04..fb5324a6c 100644 --- a/src/SketchPlugin/doc/rotationFeature.rst +++ b/src/SketchPlugin/doc/rotationFeature.rst @@ -1,3 +1,4 @@ +.. _sketchAngularCopy: Angular copy ============