+++ /dev/null
-
-.. _buildPlugin:
-
-Build plug-in
-=============
-
-.. toctree::
- :maxdepth: 1
-
- compoundFeature.rst
- compsolidFeature.rst
- edgeFeature.rst
- faceFeature.rst
- fillingFeature.rst
- interpolationFeature.rst
- polylineFeature.rst
- shellFeature.rst
- solidFeature.rst
- subShapesFeature.rst
- vertexFeature.rst
- wireFeature.rst
+++ /dev/null
-
-Compound
-========
+++ /dev/null
-
-CompSolid
-=========
+++ /dev/null
-
-Edge
-====
+++ /dev/null
-
-Face
-====
+++ /dev/null
-
- Filling
- =======
+++ /dev/null
-
-Interpolation
-=============
+++ /dev/null
-
-Polyline
-========
+++ /dev/null
-
-Shell
-=====
+++ /dev/null
-
-Solid
-=====
+++ /dev/null
-
-Sub-shapes
-==========
+++ /dev/null
-
-Vertex
-======
+++ /dev/null
-
-Wire
-====
CONFIGURE_FILE(${input} ${output})
-
#sphinx-build -b html -c doc -D latex_paper_size=a4 -d doc/doctree /dn23/PPGP/vsv/SALOME730/SOURCES/PPGP_SRC/doc doc/html
INSTALL(CODE "
EXECUTE_PROCESS(
-COMMAND ${SPHINX_EXECUTABLE} -Q -b html -c ${CMAKE_CURRENT_BINARY_DIR} -D latex_paper_size=a4 -d doctree ${CMAKE_CURRENT_SOURCE_DIR} html
-WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
-)"
+COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/build_index.py ${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_SOURCE_DIR}
)
+")
+
-IF(${HAVE_SALOME})
INSTALL(CODE "
EXECUTE_PROCESS(
-COMMAND ${PYTHON_EXECUTABLE} -c \"import shutil;shutil.rmtree('${CMAKE_INSTALL_PREFIX}/share/doc/salome/gui/SHAPER', True);shutil.copytree('${CMAKE_CURRENT_BINARY_DIR}/html', '${CMAKE_INSTALL_PREFIX}/share/doc/salome/gui/SHAPER')\"
+COMMAND ${SPHINX_EXECUTABLE} -Q -b html -c ${CMAKE_CURRENT_BINARY_DIR} -d doctree ${CMAKE_CURRENT_BINARY_DIR} html
+WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+)"
)
-")
+
+IF(${HAVE_SALOME})
+ INSTALL(CODE "
+ EXECUTE_PROCESS(
+ COMMAND ${PYTHON_EXECUTABLE} -c \"import shutil;shutil.rmtree('${CMAKE_INSTALL_PREFIX}/share/doc/salome/gui/SHAPER', True);shutil.copytree('${CMAKE_CURRENT_BINARY_DIR}/html', '${CMAKE_INSTALL_PREFIX}/share/doc/salome/gui/SHAPER')\"
+ )
+ ")
ELSE(${HAVE_SALOME})
-INSTALL(CODE "
-EXECUTE_PROCESS(
-COMMAND ${PYTHON_EXECUTABLE} -c \"import shutil;shutil.rmtree('${CMAKE_INSTALL_PREFIX}/doc/gui', True);shutil.copytree('${CMAKE_CURRENT_BINARY_DIR}/html', '${CMAKE_INSTALL_PREFIX}/doc/gui')\"
-)
-")
+ INSTALL(CODE "
+ EXECUTE_PROCESS(
+ COMMAND ${PYTHON_EXECUTABLE} -c \"import shutil;shutil.rmtree('${CMAKE_INSTALL_PREFIX}/doc/gui', True);shutil.copytree('${CMAKE_CURRENT_BINARY_DIR}/html', '${CMAKE_INSTALL_PREFIX}/doc/gui')\"
+ )
+ ")
ENDIF(${HAVE_SALOME})
+++ /dev/null
-
-.. _collectionPlugin:
-
-
-Collection plug-in
-==================
-
-.. toctree::
- :maxdepth: 1
-
- fieldFeature.rst
- groupFeature.rst
+++ /dev/null
-
-Field
-=====
+++ /dev/null
-
-Group
-=====
+++ /dev/null
-
-Axis
-====
+++ /dev/null
-
-.. _constructionPlugin:
-
-Construction plug-in
-====================
-
-.. toctree::
- :maxdepth: 1
-
- axisFeature.rst
- planeFeature.rst
- pointFeature.rst
+++ /dev/null
-
-Plane
-=====
+++ /dev/null
-
-Point
-=====
+++ /dev/null
-
-Dump
-====
+++ /dev/null
-
-.. _exchangePlugin:
-
-Exchange plug-in
-================
-
-.. toctree::
- :maxdepth: 1
-
- dumpFeature.rst
- exportFeature.rst
- importFeature.rst
+++ /dev/null
-
-Export
-======
+++ /dev/null
-
-Import
-======
+++ /dev/null
-
-Angular copy
-============
-
-
-.. image:: images/AngularCopy.png
- :align: center
-
-.. centered::
- Angular copy definition
+++ /dev/null
-
-Common
-======
-
-
-.. image:: images/Common.png
- :align: center
-
-.. centered::
- Common definition
+++ /dev/null
-
-Cut
-===
-
-
-.. image:: images/Cut.png
- :align: center
-
-.. centered::
- Cut definition
+++ /dev/null
-
-Extrusion cut
-=============
-
-
-.. image:: images/StartSketch.png
- :align: center
-
-.. centered::
- Start sketch
-
-
-.. image:: images/ExtrusionCut1.png
- :align: center
-
-.. centered::
- Extrusion: definition by sizes
-
-
-.. image:: images/ExtrusionCut2.png
- :align: center
-
-.. centered::
- Extrusion: definition by bounding planes
+++ /dev/null
-
-Extrusion
-=========
-
-
-.. image:: images/StartSketch.png
- :align: center
-
-.. centered::
- Start sketch
-
-
-.. image:: images/Extrusion1.png
- :align: center
-
-.. centered::
- Extrusion: definition by sizes
-
-
-.. image:: images/Extrusion2.png
- :align: center
-
-.. centered::
- Extrusion: definition by bounding planes
+++ /dev/null
-
-Extrusion fuse
-==============
-
-
-.. image:: images/StartSketch.png
- :align: center
-
-.. centered::
- Start sketch
-
-
-.. image:: images/ExtrusionFuse1.png
- :align: center
-
-.. centered::
- Extrusion: definition by sizes
-
-
-.. image:: images/ExtrusionFuse2.png
- :align: center
-
-.. centered::
- Extrusion: definition by bounding planes
+++ /dev/null
-
-.. _featuresPlugin:
-
-
-Features plug-in
-================
-
-
-.. toctree::
- :maxdepth: 1
-
- angularCopyFeature.rst
- commonFeature.rst
- cutFeature.rst
- extrusionCutFeature.rst
- extrusionFeature.rst
- extrusionFuseFeature.rst
- fillFeature.rst
- filletFeature.rst
- fuseFeature.rst
- intersectionFeature.rst
- linearCopyFeature.rst
- measurementFeature.rst
- partitionFeature.rst
- pipeFeature.rst
- placementFeature.rst
- recoverFeature.rst
- removeSubShapesFeature.rst
- revolutionCutFeature.rst
- revolutionFeature.rst
- revolutionFuseFeature.rst
- rotationFeature.rst
- smashFeature.rst
- symmetryFeature.rst
- transformationFeature.rst
- translationFeature.rst
- unionFeature.rst
+++ /dev/null
-
-Fill
-====
-
-
-.. image:: images/Fill.png
- :align: center
-
-.. centered::
- Fill definition
+++ /dev/null
-
-Fillet
-======
-
-
-.. image:: images/Fillet.png
- :align: center
-
-.. centered::
- Fillet by fixed radius
-
-
-.. image:: images/Fillet2.png
- :align: center
-
-.. centered::
- Fillet by varyable radius
+++ /dev/null
-
-Fuse
-====
-
-
-.. image:: images/Fuse.png
- :align: center
-
-.. centered::
- Fuse definition
+++ /dev/null
-
-Intersection
-============
-
-
-.. image:: images/Intersection.png
- :align: center
-
-.. centered::
- Intersection definition
+++ /dev/null
-
-Linear copy
-===========
-
-
-.. image:: images/LinearCopy.png
- :align: center
-
-.. centered::
- Linear copy
+++ /dev/null
-
-Measurement
-===========
-
-
-.. image:: images/Measurement1.png
- :align: center
-
-.. centered::
- Edge length
-
-
-
-.. image:: images/Measurement2.png
- :align: center
-
-.. centered::
- Distance between objects
-
-
-
-.. image:: images/Measurement3.png
- :align: center
-
-.. centered::
- Radius
-
-
-
-.. image:: images/Measurement4.png
- :align: center
-
-.. centered::
- Angle between edges
-
-
-
-.. image:: images/Measurement5.png
- :align: center
-
-.. centered::
- Angle by 3 points
+++ /dev/null
-
-Partition
-=========
-
-
-.. image:: images/Partition.png
- :align: center
-
-.. centered::
- Partition definition
+++ /dev/null
-
-Pipe
-====
-
-
-.. image:: images/Pipe1.png
- :align: center
-
-.. centered::
- Pipe by object and path
-
-
-.. image:: images/Pipe2.png
- :align: center
-
-.. centered::
- Pipe by object, path and Bi-normal
-
-
-.. image:: images/Pipe3.png
- :align: center
-
-.. centered::
- Pipe by object, path and locations
+++ /dev/null
-
-Placement
-=========
-
-
-.. image:: images/Placement.png
- :align: center
-
-.. centered::
- Placement definition
+++ /dev/null
-
- Recover
- =======
-
-
-.. image:: images/Recover.png
- :align: center
-
-.. centered::
- Recover operation
+++ /dev/null
-
-Remove sub-shapes
-=================
-
-
-.. image:: images/RemoveSubShapes.png
- :align: center
-
-.. centered::
- Remove sub-shapes
+++ /dev/null
-
-Revolution cut
-==============
-
-
-.. image:: images/StartSketch.png
- :align: center
-
-.. centered::
- Start sketch
-
-
-.. image:: images/RevolutionCut1.png
- :align: center
-
-.. centered::
- Revolution: definition by angles
-
-
-.. image:: images/RevolutionCut2.png
- :align: center
-
-.. centered::
- Extrusion: definition by bounding planes
+++ /dev/null
-
-Revolution
-==========
-
-
-.. image:: images/StartSketch.png
- :align: center
-
-.. centered::
- Start sketch
-
-
-.. image:: images/Revolution1.png
- :align: center
-
-.. centered::
- Revolution: definition by angles
-
-
-.. image:: images/Revolution2.png
- :align: center
-
-.. centered::
- Extrusion: definition by bounding planes
+++ /dev/null
-
-Revolution fuse
-===============
-
-
-.. image:: images/StartSketch.png
- :align: center
-
-.. centered::
- Start sketch
-
-
-.. image:: images/RevolutionFuse1.png
- :align: center
-
-.. centered::
- Revolution: definition by angles
-
-
-.. image:: images/RevolutionFuse2.png
- :align: center
-
-.. centered::
- Extrusion: definition by bounding planes
+++ /dev/null
-
-Rotation
-========
-
-
-.. image:: images/Rotation1.png
- :align: center
-
-.. centered::
- Rotation by axis and angle
-
-
-.. image:: images/Rotation2.png
- :align: center
-
-.. centered::
- Rotation by center and points
+++ /dev/null
-
-Smash
-=====
-
-
-.. image:: images/Smash.png
- :align: center
-
-.. centered::
- Smash definition
+++ /dev/null
-
-Symmetry
-========
-
-
-.. image:: images/Symmetry.png
- :align: center
-
-.. centered::
- Symmetry definition
+++ /dev/null
-
-Scale
-=====
-
-
-.. image:: images/Scale1.png
- :align: center
-
-.. centered::
- Scale: define by a one common factor
-
-
-.. image:: images/Scale2.png
- :align: center
-
-.. centered::
- Scale: define by different factors
+++ /dev/null
-
-Translation
-===========
-
-
-.. image:: images/Translation1.png
- :align: center
-
-.. centered::
- Translation by axis and distance
-
-
-.. image:: images/Translation2.png
- :align: center
-
-.. centered::
- By vector
-
-
-.. image:: images/Translation3.png
- :align: center
-
-.. centered::
- By two points
+++ /dev/null
-
-Union
-=====
-
-
-.. image:: images/Union.png
- :align: center
-
-.. centered::
- Union definition
+++ /dev/null
-
-.. _gdmlPlugin:
-
-GDML plug-in
-=============
-
-.. toctree::
- :maxdepth: 1
-
- coneFeature.rst
- ellipsoidFeature.rst
+++ /dev/null
-
-Cone
-====
+++ /dev/null
-
-Ellipsoid
-=========
+++ /dev/null
-
-Parameters manager
-==================
+++ /dev/null
-
-Create parameter
-================
+++ /dev/null
-
-.. _parametersPlugin:
-
-Parameters plug-in
-==================
-
-.. toctree::
- :maxdepth: 1
-
- managerFeature.rst
- parameterFeature.rst
+++ /dev/null
-
-.. _partPlugin:
-
-Part plug-in
-=============
+++ /dev/null
-
-Box
-===
+++ /dev/null
-
-Cone
-====
+++ /dev/null
-
-Cylinder
-========
+++ /dev/null
-
-.. _primitivesPlugin:
-
-Primitives plug-in
-==================
-
-.. toctree::
- :maxdepth: 1
-
- boxFeature.rst
- coneFeature.rst
- cylinderFeature.rst
- sphereFeature.rst
- torusFeature.rst
+++ /dev/null
-
-Sphere
-======
+++ /dev/null
-
-Torus
-=====
+++ /dev/null
-
-Angle constraint
-================
+++ /dev/null
-
-Arc
-===
-
-
-.. image:: images/Arc1.png
- :align: center
-
-.. centered::
- Create arc by center and two points
-
-
-.. image:: images/Arc2.png
- :align: center
-
-.. centered::
- Create arc by three points
-
-
-.. image:: images/Arc3.png
- :align: center
-
-.. centered::
- Create arc as tangent to an edge
+++ /dev/null
-
-Circle
-======
-
-
-.. image:: images/Circle1.png
- :align: center
-
-.. centered::
- Create circle by center and point
-
-
-.. image:: images/Circle2.png
- :align: center
-
-.. centered::
- Create circle by tree points
+++ /dev/null
-
-Coincidence constraint
-======================
+++ /dev/null
-
-Collinear constraint
-====================
+++ /dev/null
-
-Distance constraint
-===================
+++ /dev/null
-
- Ellipse
- =======
+++ /dev/null
-
-Equal constraint
-================
+++ /dev/null
-
-Fillet
-======
-
-
-.. image:: images/Fillet.png
- :align: center
-
-.. centered::
- Create a fillet
+++ /dev/null
-
-Horizontal distance constraint
-==============================
+++ /dev/null
-
-Horizontal constraint
-=====================
+++ /dev/null
-
-Intersection
-============
-
-
-.. image:: images/Intersection.png
- :align: center
-
-.. centered::
- Create an intersection
+++ /dev/null
-
-Length constraint
-=================
+++ /dev/null
-
-Line
-====
-
-
-.. image:: images/Line.png
- :align: center
-
-.. centered::
- Create a line
+++ /dev/null
-
-Middle constraint
-=================
+++ /dev/null
-
-Mirror
-======
+++ /dev/null
-
-Parallel constraint
-===================
+++ /dev/null
-
-Perpendicular constraint
-========================
+++ /dev/null
-
-Point
-=====
-
-
-.. image:: images/Point.png
- :align: center
-
-.. centered::
- Create a point
+++ /dev/null
-
-Projection
-==========
-
-
-.. image:: images/Projection.png
- :align: center
-
-.. centered::
- Create a projection
+++ /dev/null
-
-Radius constraint
-=================
+++ /dev/null
-
-Rectangle
-=========
-
-
-.. image:: images/Rectangle.png
- :align: center
-
-.. centered::
- Create a rectangle
+++ /dev/null
-
-Rigid constraint
-================
+++ /dev/null
-
-Rotation
-========
+++ /dev/null
-
-.. _sketchPlugin:
-
-
-Sketch plug-in
-================
-
-
-.. image:: images/StartSketch.png
- :align: center
-
-.. centered::
- Start sketcher
-
-
-
-.. image:: images/SketchProperties.png
- :align: center
-
-.. centered::
- Sketcher properies panel
-
-
-Sketch objects
---------------
-
-.. toctree::
- :maxdepth: 1
-
- arcFeature.rst
- circleFeature.rst
- ellipseFeature.rst
- lineFeature.rst
- pointFeature.rst
-
-Constraints
------------
-
-.. toctree::
- :maxdepth: 1
-
- angleFeature.rst
- coincedenceFeature.rst
- collinearFeature.rst
- distanceFeature.rst
- equalFeature.rst
- horizontalDistFeature.rst
- horizontalFeature.rst
- lengthFeature.rst
- middleFeature.rst
- parallelFeature.rst
- perpendicularFeature.rst
- radiusFeature.rst
- rigidFeature.rst
- tangentFeature.rst
- verticalDistFeature.rst
- verticalFeature.rst
-
-Operations
-----------
-
-.. toctree::
- :maxdepth: 1
-
- filletFeature.rst
- intersectionFeature.rst
- mirrorFeature.rst
- projectionFeature.rst
- rotationFeature.rst
- splitFeature.rst
- translationFeature.rst
- trimFeature.rst
+++ /dev/null
-
-Split
-=====
-
-
-.. image:: images/Split.png
- :align: center
-
-.. centered::
- Split a line
+++ /dev/null
-
-Tangent constraint
-==================
+++ /dev/null
-
-Translation
-===========
+++ /dev/null
-
-Trim
-====
-
-
-.. image:: images/Trim.png
- :align: center
-
-.. centered::
- Trim a line
+++ /dev/null
-
-Vertical distance constraint
-============================
+++ /dev/null
-
-Vertical constraint
-===================
--- /dev/null
+## Copyright (C) 2014-2017 CEA/DEN, EDF R&D
+##
+## This library is free software; you can redistribute it and/or
+## modify it under the terms of the GNU Lesser General Public
+## License as published by the Free Software Foundation; either
+## version 2.1 of the License, or (at your option) any later version.
+##
+## This library is distributed in the hope that it will be useful,
+## but WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+## Lesser General Public License for more details.
+##
+## You should have received a copy of the GNU Lesser General Public
+## License along with this library; if not, write to the Free Software
+## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+##
+## See http:##www.salome-platform.org/ or
+## email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
+##
+
+###
+## The script collects information about help documents in plugins
+## and prepares building of help documentation by sphinx
+###
+
+import os
+import sys
+import shutil
+from xml.dom.minidom import parse
+
+aBuildDir = sys.argv[1]
+aSourcesDir = sys.argv[2]
+aSrcPath = aSourcesDir + os.sep + "../../src"
+
+aConfigPath = aSrcPath + os.sep + "Config/plugins.xml.in"
+
+## Find accessible plugins from plugins.xml configuration file
+aPluginList = []
+aDomObj = parse(aConfigPath)
+aPluginsList = aDomObj.getElementsByTagName("plugin")
+for plugin in aPluginsList:
+ aLibName = plugin.getAttribute("library")
+ if aLibName:
+ aPluginDocDir = aSrcPath + os.sep + aLibName + os.sep + "doc"
+ aDocDist = aBuildDir + os.sep + aLibName
+ if os.path.exists(aPluginDocDir):
+ ## Copy all files to a building directory
+ if os.path.exists(aDocDist):
+ shutil.rmtree(aDocDist)
+ shutil.copytree(aPluginDocDir, aDocDist)
+ aPluginList.append(aLibName)
+
+## Modify index.rst file accordingly
+aIndexFile = open(aSourcesDir + os.sep + "index.rst.in", 'r')
+aIndexLines = aIndexFile.readlines()
+aIndexFile.close()
+
+## Add list of plugins after toctree directive
+aIndexLines.append('\n')
+for aLibName in aPluginList:
+ aIndexLines.append(" " + aLibName + "/" + aLibName + ".rst\n")
+
+aNewIndex = open(aBuildDir + os.sep + "index.rst", 'w')
+aNewIndex.writelines(aIndexLines)
+aNewIndex.close()
\ No newline at end of file
+++ /dev/null
-.. SHAPER documentation master file, created by
- sphinx-quickstart on Fri Aug 3 11:29:53 2018.
- You can adapt this file completely to your liking, but it should at least
- contain the root `toctree` directive.
-
-Welcome to SHAPER's documentation!
-==================================
-
-.. toctree::
- :maxdepth: 1
- :caption: Contents:
-
- FeaturesPlugin/featuresPlugin.rst
- SketchPlugin/sketchPlugin.rst
- BuildPlugin/buildPlugin.rst
- CollectionPlugin/collectionPlugin.rst
- ConstructionPlugin/constructionPlugin.rst
- ExchangePlugin/exchangePlugin.rst
- GDMLPlugin/GDMLPlugin.rst
- ParametersPlugin/parametersPlugin.rst
- PartPlugin/partPlugin.rst
- PrimitivesPlugin/primitivesPlugin.rst
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
--- /dev/null
+.. SHAPER documentation master file, created by
+ sphinx-quickstart on Fri Aug 3 11:29:53 2018.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to SHAPER's documentation!
+==================================
+
+.. toctree::
+ :maxdepth: 1
+ :caption: Contents:
--- /dev/null
+
+.. _buildPlugin:
+
+Build plug-in
+=============
+
+.. toctree::
+ :maxdepth: 1
+
+ compoundFeature.rst
+ compsolidFeature.rst
+ edgeFeature.rst
+ faceFeature.rst
+ fillingFeature.rst
+ interpolationFeature.rst
+ polylineFeature.rst
+ shellFeature.rst
+ solidFeature.rst
+ subShapesFeature.rst
+ vertexFeature.rst
+ wireFeature.rst
--- /dev/null
+
+Compound
+========
--- /dev/null
+
+CompSolid
+=========
--- /dev/null
+
+Edge
+====
--- /dev/null
+
+Face
+====
--- /dev/null
+
+ Filling
+ =======
--- /dev/null
+
+Interpolation
+=============
--- /dev/null
+
+Polyline
+========
--- /dev/null
+
+Shell
+=====
--- /dev/null
+
+Solid
+=====
--- /dev/null
+
+Sub-shapes
+==========
--- /dev/null
+
+Vertex
+======
--- /dev/null
+
+Wire
+====
--- /dev/null
+
+.. _collectionPlugin:
+
+
+Collection plug-in
+==================
+
+.. toctree::
+ :maxdepth: 1
+
+ fieldFeature.rst
+ groupFeature.rst
--- /dev/null
+
+Field
+=====
--- /dev/null
+
+Group
+=====
--- /dev/null
+
+.. _constructionPlugin:
+
+Construction plug-in
+====================
+
+.. toctree::
+ :maxdepth: 1
+
+ axisFeature.rst
+ planeFeature.rst
+ pointFeature.rst
--- /dev/null
+
+Axis
+====
--- /dev/null
+
+Plane
+=====
--- /dev/null
+
+Point
+=====
--- /dev/null
+
+.. _exchangePlugin:
+
+Exchange plug-in
+================
+
+.. toctree::
+ :maxdepth: 1
+
+ dumpFeature.rst
+ exportFeature.rst
+ importFeature.rst
--- /dev/null
+
+Dump
+====
--- /dev/null
+
+Export
+======
--- /dev/null
+
+Import
+======
--- /dev/null
+
+.. _featuresPlugin:
+
+
+Features plug-in
+================
+
+
+.. toctree::
+ :maxdepth: 1
+
+ angularCopyFeature.rst
+ commonFeature.rst
+ cutFeature.rst
+ extrusionCutFeature.rst
+ extrusionFeature.rst
+ extrusionFuseFeature.rst
+ fillFeature.rst
+ filletFeature.rst
+ fuseFeature.rst
+ intersectionFeature.rst
+ linearCopyFeature.rst
+ measurementFeature.rst
+ partitionFeature.rst
+ pipeFeature.rst
+ placementFeature.rst
+ recoverFeature.rst
+ removeSubShapesFeature.rst
+ revolutionCutFeature.rst
+ revolutionFeature.rst
+ revolutionFuseFeature.rst
+ rotationFeature.rst
+ smashFeature.rst
+ symmetryFeature.rst
+ transformationFeature.rst
+ translationFeature.rst
+ unionFeature.rst
--- /dev/null
+
+Angular copy
+============
+
+
+.. image:: images/AngularCopy.png
+ :align: center
+
+.. centered::
+ Angular copy definition
--- /dev/null
+
+Common
+======
+
+
+.. image:: images/Common.png
+ :align: center
+
+.. centered::
+ Common definition
--- /dev/null
+
+Cut
+===
+
+
+.. image:: images/Cut.png
+ :align: center
+
+.. centered::
+ Cut definition
--- /dev/null
+
+Extrusion cut
+=============
+
+
+.. image:: images/StartSketch.png
+ :align: center
+
+.. centered::
+ Start sketch
+
+
+.. image:: images/ExtrusionCut1.png
+ :align: center
+
+.. centered::
+ Extrusion: definition by sizes
+
+
+.. image:: images/ExtrusionCut2.png
+ :align: center
+
+.. centered::
+ Extrusion: definition by bounding planes
--- /dev/null
+
+Extrusion
+=========
+
+
+.. image:: images/StartSketch.png
+ :align: center
+
+.. centered::
+ Start sketch
+
+
+.. image:: images/Extrusion1.png
+ :align: center
+
+.. centered::
+ Extrusion: definition by sizes
+
+
+.. image:: images/Extrusion2.png
+ :align: center
+
+.. centered::
+ Extrusion: definition by bounding planes
--- /dev/null
+
+Extrusion fuse
+==============
+
+
+.. image:: images/StartSketch.png
+ :align: center
+
+.. centered::
+ Start sketch
+
+
+.. image:: images/ExtrusionFuse1.png
+ :align: center
+
+.. centered::
+ Extrusion: definition by sizes
+
+
+.. image:: images/ExtrusionFuse2.png
+ :align: center
+
+.. centered::
+ Extrusion: definition by bounding planes
--- /dev/null
+
+Fill
+====
+
+
+.. image:: images/Fill.png
+ :align: center
+
+.. centered::
+ Fill definition
--- /dev/null
+
+Fillet
+======
+
+
+.. image:: images/Fillet.png
+ :align: center
+
+.. centered::
+ Fillet by fixed radius
+
+
+.. image:: images/Fillet2.png
+ :align: center
+
+.. centered::
+ Fillet by varyable radius
--- /dev/null
+
+Fuse
+====
+
+
+.. image:: images/Fuse.png
+ :align: center
+
+.. centered::
+ Fuse definition
--- /dev/null
+
+Intersection
+============
+
+
+.. image:: images/Intersection.png
+ :align: center
+
+.. centered::
+ Intersection definition
--- /dev/null
+
+Linear copy
+===========
+
+
+.. image:: images/LinearCopy.png
+ :align: center
+
+.. centered::
+ Linear copy
--- /dev/null
+
+Measurement
+===========
+
+
+.. image:: images/Measurement1.png
+ :align: center
+
+.. centered::
+ Edge length
+
+
+
+.. image:: images/Measurement2.png
+ :align: center
+
+.. centered::
+ Distance between objects
+
+
+
+.. image:: images/Measurement3.png
+ :align: center
+
+.. centered::
+ Radius
+
+
+
+.. image:: images/Measurement4.png
+ :align: center
+
+.. centered::
+ Angle between edges
+
+
+
+.. image:: images/Measurement5.png
+ :align: center
+
+.. centered::
+ Angle by 3 points
--- /dev/null
+
+Partition
+=========
+
+
+.. image:: images/Partition.png
+ :align: center
+
+.. centered::
+ Partition definition
--- /dev/null
+
+Pipe
+====
+
+
+.. image:: images/Pipe1.png
+ :align: center
+
+.. centered::
+ Pipe by object and path
+
+
+.. image:: images/Pipe2.png
+ :align: center
+
+.. centered::
+ Pipe by object, path and Bi-normal
+
+
+.. image:: images/Pipe3.png
+ :align: center
+
+.. centered::
+ Pipe by object, path and locations
--- /dev/null
+
+Placement
+=========
+
+
+.. image:: images/Placement.png
+ :align: center
+
+.. centered::
+ Placement definition
--- /dev/null
+
+ Recover
+ =======
+
+
+.. image:: images/Recover.png
+ :align: center
+
+.. centered::
+ Recover operation
--- /dev/null
+
+Remove sub-shapes
+=================
+
+
+.. image:: images/RemoveSubShapes.png
+ :align: center
+
+.. centered::
+ Remove sub-shapes
--- /dev/null
+
+Revolution cut
+==============
+
+
+.. image:: images/StartSketch.png
+ :align: center
+
+.. centered::
+ Start sketch
+
+
+.. image:: images/RevolutionCut1.png
+ :align: center
+
+.. centered::
+ Revolution: definition by angles
+
+
+.. image:: images/RevolutionCut2.png
+ :align: center
+
+.. centered::
+ Extrusion: definition by bounding planes
--- /dev/null
+
+Revolution
+==========
+
+
+.. image:: images/StartSketch.png
+ :align: center
+
+.. centered::
+ Start sketch
+
+
+.. image:: images/Revolution1.png
+ :align: center
+
+.. centered::
+ Revolution: definition by angles
+
+
+.. image:: images/Revolution2.png
+ :align: center
+
+.. centered::
+ Extrusion: definition by bounding planes
--- /dev/null
+
+Revolution fuse
+===============
+
+
+.. image:: images/StartSketch.png
+ :align: center
+
+.. centered::
+ Start sketch
+
+
+.. image:: images/RevolutionFuse1.png
+ :align: center
+
+.. centered::
+ Revolution: definition by angles
+
+
+.. image:: images/RevolutionFuse2.png
+ :align: center
+
+.. centered::
+ Extrusion: definition by bounding planes
--- /dev/null
+
+Rotation
+========
+
+
+.. image:: images/Rotation1.png
+ :align: center
+
+.. centered::
+ Rotation by axis and angle
+
+
+.. image:: images/Rotation2.png
+ :align: center
+
+.. centered::
+ Rotation by center and points
--- /dev/null
+
+Smash
+=====
+
+
+.. image:: images/Smash.png
+ :align: center
+
+.. centered::
+ Smash definition
--- /dev/null
+
+Symmetry
+========
+
+
+.. image:: images/Symmetry.png
+ :align: center
+
+.. centered::
+ Symmetry definition
--- /dev/null
+
+Scale
+=====
+
+
+.. image:: images/Scale1.png
+ :align: center
+
+.. centered::
+ Scale: define by a one common factor
+
+
+.. image:: images/Scale2.png
+ :align: center
+
+.. centered::
+ Scale: define by different factors
--- /dev/null
+
+Translation
+===========
+
+
+.. image:: images/Translation1.png
+ :align: center
+
+.. centered::
+ Translation by axis and distance
+
+
+.. image:: images/Translation2.png
+ :align: center
+
+.. centered::
+ By vector
+
+
+.. image:: images/Translation3.png
+ :align: center
+
+.. centered::
+ By two points
--- /dev/null
+
+Union
+=====
+
+
+.. image:: images/Union.png
+ :align: center
+
+.. centered::
+ Union definition
--- /dev/null
+
+.. _gdmlPlugin:
+
+GDML plug-in
+=============
+
+.. toctree::
+ :maxdepth: 1
+
+ coneFeature.rst
+ ellipsoidFeature.rst
--- /dev/null
+
+Cone
+====
--- /dev/null
+
+Ellipsoid
+=========
--- /dev/null
+
+.. _parametersPlugin:
+
+Parameters plug-in
+==================
+
+.. toctree::
+ :maxdepth: 1
+
+ managerFeature.rst
+ parameterFeature.rst
--- /dev/null
+
+Parameters manager
+==================
--- /dev/null
+
+Create parameter
+================
--- /dev/null
+
+.. _partPlugin:
+
+Part plug-in
+=============
--- /dev/null
+
+.. _primitivesPlugin:
+
+Primitives plug-in
+==================
+
+.. toctree::
+ :maxdepth: 1
+
+ boxFeature.rst
+ coneFeature.rst
+ cylinderFeature.rst
+ sphereFeature.rst
+ torusFeature.rst
--- /dev/null
+
+Box
+===
--- /dev/null
+
+Cone
+====
--- /dev/null
+
+Cylinder
+========
--- /dev/null
+
+Sphere
+======
--- /dev/null
+
+Torus
+=====
--- /dev/null
+## Copyright (C) 2014-2017 CEA/DEN, EDF R&D
+##
+## This library is free software; you can redistribute it and/or
+## modify it under the terms of the GNU Lesser General Public
+## License as published by the Free Software Foundation; either
+## version 2.1 of the License, or (at your option) any later version.
+##
+## This library is distributed in the hope that it will be useful,
+## but WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+## Lesser General Public License for more details.
+##
+## You should have received a copy of the GNU Lesser General Public
+## License along with this library; if not, write to the Free Software
+## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+##
+## See http:##www.salome-platform.org/ or
+## email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
+##
+
+
+#sphinx-build -b html -c doc -D latex_paper_size=a4 -d doc/doctree /dn23/PPGP/vsv/SALOME730/SOURCES/PPGP_SRC/doc doc/html
+
+
+INSTALL(CODE "
+EXECUTE_PROCESS(
+COMMAND ${SPHINX_EXECUTABLE} -Q -b html -c ${DOC_BUILD_DIR} -d doctree ${CMAKE_CURRENT_SOURCE_DIR} ${DOC_BUILD_DIR}/html/SketchPlugin
+WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+)"
+)
+
+
+# IF(${HAVE_SALOME})
+# INSTALL(CODE "
+# EXECUTE_PROCESS(
+# COMMAND ${PYTHON_EXECUTABLE} -c \"import shutil;shutil.rmtree('${CMAKE_INSTALL_PREFIX}/share/doc/salome/gui/SHAPER', True);shutil.copytree('${CMAKE_CURRENT_BINARY_DIR}/html', '${CMAKE_INSTALL_PREFIX}/share/doc/salome/gui/SHAPER')\"
+# )
+# ")
+# ELSE(${HAVE_SALOME})
+# INSTALL(CODE "
+# EXECUTE_PROCESS(
+# COMMAND ${PYTHON_EXECUTABLE} -c \"import shutil;shutil.rmtree('${CMAKE_INSTALL_PREFIX}/doc/gui', True);shutil.copytree('${CMAKE_CURRENT_BINARY_DIR}/html', '${CMAKE_INSTALL_PREFIX}/doc/gui')\"
+# )
+# ")
+# ENDIF(${HAVE_SALOME})
--- /dev/null
+
+.. _sketchPlugin:
+
+
+Sketch plug-in
+================
+
+
+.. image:: images/StartSketch.png
+ :align: center
+
+.. centered::
+ Start sketcher
+
+
+
+.. image:: images/SketchProperties.png
+ :align: center
+
+.. centered::
+ Sketcher properies panel
+
+
+Sketch objects
+--------------
+
+.. toctree::
+ :maxdepth: 1
+
+ arcFeature.rst
+ circleFeature.rst
+ ellipseFeature.rst
+ lineFeature.rst
+ pointFeature.rst
+
+Constraints
+-----------
+
+.. toctree::
+ :maxdepth: 1
+
+ angleFeature.rst
+ coincedenceFeature.rst
+ collinearFeature.rst
+ distanceFeature.rst
+ equalFeature.rst
+ horizontalDistFeature.rst
+ horizontalFeature.rst
+ lengthFeature.rst
+ middleFeature.rst
+ parallelFeature.rst
+ perpendicularFeature.rst
+ radiusFeature.rst
+ rigidFeature.rst
+ tangentFeature.rst
+ verticalDistFeature.rst
+ verticalFeature.rst
+
+Operations
+----------
+
+.. toctree::
+ :maxdepth: 1
+
+ filletFeature.rst
+ intersectionFeature.rst
+ mirrorFeature.rst
+ projectionFeature.rst
+ rotationFeature.rst
+ splitFeature.rst
+ translationFeature.rst
+ trimFeature.rst
--- /dev/null
+
+Angle constraint
+================
--- /dev/null
+
+Arc
+===
+
+
+.. image:: images/Arc1.png
+ :align: center
+
+.. centered::
+ Create arc by center and two points
+
+
+.. image:: images/Arc2.png
+ :align: center
+
+.. centered::
+ Create arc by three points
+
+
+.. image:: images/Arc3.png
+ :align: center
+
+.. centered::
+ Create arc as tangent to an edge
--- /dev/null
+
+Circle
+======
+
+
+.. image:: images/Circle1.png
+ :align: center
+
+.. centered::
+ Create circle by center and point
+
+
+.. image:: images/Circle2.png
+ :align: center
+
+.. centered::
+ Create circle by tree points
--- /dev/null
+
+Coincidence constraint
+======================
--- /dev/null
+
+Collinear constraint
+====================
--- /dev/null
+
+Distance constraint
+===================
--- /dev/null
+
+ Ellipse
+ =======
--- /dev/null
+
+Equal constraint
+================
--- /dev/null
+
+Fillet
+======
+
+
+.. image:: images/Fillet.png
+ :align: center
+
+.. centered::
+ Create a fillet
--- /dev/null
+
+Horizontal distance constraint
+==============================
--- /dev/null
+
+Horizontal constraint
+=====================
--- /dev/null
+
+Intersection
+============
+
+
+.. image:: images/Intersection.png
+ :align: center
+
+.. centered::
+ Create an intersection
--- /dev/null
+
+Length constraint
+=================
--- /dev/null
+
+Line
+====
+
+
+.. image:: images/Line.png
+ :align: center
+
+.. centered::
+ Create a line
--- /dev/null
+
+Middle constraint
+=================
--- /dev/null
+
+Mirror
+======
--- /dev/null
+
+Parallel constraint
+===================
--- /dev/null
+
+Perpendicular constraint
+========================
--- /dev/null
+
+Point
+=====
+
+
+.. image:: images/Point.png
+ :align: center
+
+.. centered::
+ Create a point
--- /dev/null
+
+Projection
+==========
+
+
+.. image:: images/Projection.png
+ :align: center
+
+.. centered::
+ Create a projection
--- /dev/null
+
+Radius constraint
+=================
--- /dev/null
+
+Rectangle
+=========
+
+
+.. image:: images/Rectangle.png
+ :align: center
+
+.. centered::
+ Create a rectangle
--- /dev/null
+
+Rigid constraint
+================
--- /dev/null
+
+Rotation
+========
--- /dev/null
+
+Split
+=====
+
+
+.. image:: images/Split.png
+ :align: center
+
+.. centered::
+ Split a line
--- /dev/null
+
+Tangent constraint
+==================
--- /dev/null
+
+Translation
+===========
--- /dev/null
+
+Trim
+====
+
+
+.. image:: images/Trim.png
+ :align: center
+
+.. centered::
+ Trim a line
--- /dev/null
+
+Vertical distance constraint
+============================
--- /dev/null
+
+Vertical constraint
+===================
