]> SALOME platform Git repositories - modules/shaper.git/commitdiff
Salome HOME
Add SketchPlugin document template.
authorvsv <vsv@opencascade.com>
Tue, 7 Aug 2018 13:33:12 +0000 (16:33 +0300)
committermpv <mikhail.ponikarov@opencascade.com>
Fri, 10 Aug 2018 07:37:22 +0000 (10:37 +0300)
Set SALOME help documents template.

52 files changed:
doc/gui/Makefile [deleted file]
doc/gui/SketchPlugin/angleFeature.rst [new file with mode: 0644]
doc/gui/SketchPlugin/arcFeature.rst [new file with mode: 0644]
doc/gui/SketchPlugin/circleFeature.rst [new file with mode: 0644]
doc/gui/SketchPlugin/coincedenceFeature.rst [new file with mode: 0644]
doc/gui/SketchPlugin/collinearFeature.rst [new file with mode: 0644]
doc/gui/SketchPlugin/distanceFeature.rst [new file with mode: 0644]
doc/gui/SketchPlugin/ellipseFeature.rst [new file with mode: 0644]
doc/gui/SketchPlugin/equalFeature.rst [new file with mode: 0644]
doc/gui/SketchPlugin/filletFeature.rst [new file with mode: 0644]
doc/gui/SketchPlugin/horizontalDistFeature.rst [new file with mode: 0644]
doc/gui/SketchPlugin/horizontalFeature.rst [new file with mode: 0644]
doc/gui/SketchPlugin/images/Arc1.png [new file with mode: 0644]
doc/gui/SketchPlugin/images/Arc2.png [new file with mode: 0644]
doc/gui/SketchPlugin/images/Arc3.png [new file with mode: 0644]
doc/gui/SketchPlugin/images/Circle1.png [new file with mode: 0644]
doc/gui/SketchPlugin/images/Circle2.png [new file with mode: 0644]
doc/gui/SketchPlugin/images/Fillet.png [new file with mode: 0644]
doc/gui/SketchPlugin/images/Intersection.png [new file with mode: 0644]
doc/gui/SketchPlugin/images/Line.png [new file with mode: 0644]
doc/gui/SketchPlugin/images/Point.png [new file with mode: 0644]
doc/gui/SketchPlugin/images/Projection.png [new file with mode: 0644]
doc/gui/SketchPlugin/images/Rectangle.png [new file with mode: 0644]
doc/gui/SketchPlugin/images/SketchProperties.png [new file with mode: 0644]
doc/gui/SketchPlugin/images/Split.png [new file with mode: 0644]
doc/gui/SketchPlugin/images/StartSketch.png [new file with mode: 0644]
doc/gui/SketchPlugin/images/Trim.png [new file with mode: 0644]
doc/gui/SketchPlugin/intersectionFeature.rst [new file with mode: 0644]
doc/gui/SketchPlugin/lengthFeature.rst [new file with mode: 0644]
doc/gui/SketchPlugin/lineFeature.rst [new file with mode: 0644]
doc/gui/SketchPlugin/middleFeature.rst [new file with mode: 0644]
doc/gui/SketchPlugin/mirrorFeature.rst [new file with mode: 0644]
doc/gui/SketchPlugin/parallelFeature.rst [new file with mode: 0644]
doc/gui/SketchPlugin/perpendicularFeature.rst [new file with mode: 0644]
doc/gui/SketchPlugin/pointFeature.rst [new file with mode: 0644]
doc/gui/SketchPlugin/projectionFeature.rst [new file with mode: 0644]
doc/gui/SketchPlugin/radiusFeature.rst [new file with mode: 0644]
doc/gui/SketchPlugin/rigidFeature.rst [new file with mode: 0644]
doc/gui/SketchPlugin/rotationFeature.rst [new file with mode: 0644]
doc/gui/SketchPlugin/sketchPlugin.rst [new file with mode: 0644]
doc/gui/SketchPlugin/splitFeature.rst [new file with mode: 0644]
doc/gui/SketchPlugin/tangentFeature.rst [new file with mode: 0644]
doc/gui/SketchPlugin/translationFeature.rst [new file with mode: 0644]
doc/gui/SketchPlugin/trimFeature.rst [new file with mode: 0644]
doc/gui/SketchPlugin/verticalDistFeature.rst [new file with mode: 0644]
doc/gui/SketchPlugin/verticalFeature.rst [new file with mode: 0644]
doc/gui/conf.py.in
doc/gui/index.rst
doc/gui/make.bat [deleted file]
doc/gui/static/switchers.js.in [new file with mode: 0644]
doc/gui/templates/layout.html [new file with mode: 0644]
src/SketchPlugin/plugin-Sketch.xml

diff --git a/doc/gui/Makefile b/doc/gui/Makefile
deleted file mode 100644 (file)
index 2cd260e..0000000
+++ /dev/null
@@ -1,20 +0,0 @@
-# Minimal makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line.
-SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
-SPHINXPROJ    = SHAPER
-SOURCEDIR     = .
-BUILDDIR      = _build
-
-# Put it first so that "make" without argument is like "make help".
-help:
-       @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-.PHONY: help Makefile
-
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
-       @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
\ No newline at end of file
diff --git a/doc/gui/SketchPlugin/angleFeature.rst b/doc/gui/SketchPlugin/angleFeature.rst
new file mode 100644 (file)
index 0000000..b952464
--- /dev/null
@@ -0,0 +1,3 @@
+
+Angle constraint
+================
diff --git a/doc/gui/SketchPlugin/arcFeature.rst b/doc/gui/SketchPlugin/arcFeature.rst
new file mode 100644 (file)
index 0000000..cbc880f
--- /dev/null
@@ -0,0 +1,3 @@
+
+Arc
+===
diff --git a/doc/gui/SketchPlugin/circleFeature.rst b/doc/gui/SketchPlugin/circleFeature.rst
new file mode 100644 (file)
index 0000000..3142b2a
--- /dev/null
@@ -0,0 +1,3 @@
+
+Circle
+======
diff --git a/doc/gui/SketchPlugin/coincedenceFeature.rst b/doc/gui/SketchPlugin/coincedenceFeature.rst
new file mode 100644 (file)
index 0000000..9ac094f
--- /dev/null
@@ -0,0 +1,3 @@
+
+Coincidence constraint
+======================
diff --git a/doc/gui/SketchPlugin/collinearFeature.rst b/doc/gui/SketchPlugin/collinearFeature.rst
new file mode 100644 (file)
index 0000000..dafedfd
--- /dev/null
@@ -0,0 +1,3 @@
+
+Collinear constraint
+====================
diff --git a/doc/gui/SketchPlugin/distanceFeature.rst b/doc/gui/SketchPlugin/distanceFeature.rst
new file mode 100644 (file)
index 0000000..d2414d8
--- /dev/null
@@ -0,0 +1,3 @@
+
+Distance constraint
+===================
diff --git a/doc/gui/SketchPlugin/ellipseFeature.rst b/doc/gui/SketchPlugin/ellipseFeature.rst
new file mode 100644 (file)
index 0000000..bc751c0
--- /dev/null
@@ -0,0 +1,3 @@
+
+ Ellipse
+ =======
diff --git a/doc/gui/SketchPlugin/equalFeature.rst b/doc/gui/SketchPlugin/equalFeature.rst
new file mode 100644 (file)
index 0000000..5c265e3
--- /dev/null
@@ -0,0 +1,3 @@
+
+Equal constraint
+================
diff --git a/doc/gui/SketchPlugin/filletFeature.rst b/doc/gui/SketchPlugin/filletFeature.rst
new file mode 100644 (file)
index 0000000..879ce59
--- /dev/null
@@ -0,0 +1,3 @@
+
+Fillet
+======
diff --git a/doc/gui/SketchPlugin/horizontalDistFeature.rst b/doc/gui/SketchPlugin/horizontalDistFeature.rst
new file mode 100644 (file)
index 0000000..f8008e2
--- /dev/null
@@ -0,0 +1,3 @@
+
+Horizontal distance constraint
+==============================
diff --git a/doc/gui/SketchPlugin/horizontalFeature.rst b/doc/gui/SketchPlugin/horizontalFeature.rst
new file mode 100644 (file)
index 0000000..af71b88
--- /dev/null
@@ -0,0 +1,3 @@
+
+Horizontal constraint
+=====================
diff --git a/doc/gui/SketchPlugin/images/Arc1.png b/doc/gui/SketchPlugin/images/Arc1.png
new file mode 100644 (file)
index 0000000..f05a75e
Binary files /dev/null and b/doc/gui/SketchPlugin/images/Arc1.png differ
diff --git a/doc/gui/SketchPlugin/images/Arc2.png b/doc/gui/SketchPlugin/images/Arc2.png
new file mode 100644 (file)
index 0000000..17ece66
Binary files /dev/null and b/doc/gui/SketchPlugin/images/Arc2.png differ
diff --git a/doc/gui/SketchPlugin/images/Arc3.png b/doc/gui/SketchPlugin/images/Arc3.png
new file mode 100644 (file)
index 0000000..ba8d07c
Binary files /dev/null and b/doc/gui/SketchPlugin/images/Arc3.png differ
diff --git a/doc/gui/SketchPlugin/images/Circle1.png b/doc/gui/SketchPlugin/images/Circle1.png
new file mode 100644 (file)
index 0000000..86c3d9c
Binary files /dev/null and b/doc/gui/SketchPlugin/images/Circle1.png differ
diff --git a/doc/gui/SketchPlugin/images/Circle2.png b/doc/gui/SketchPlugin/images/Circle2.png
new file mode 100644 (file)
index 0000000..34c206d
Binary files /dev/null and b/doc/gui/SketchPlugin/images/Circle2.png differ
diff --git a/doc/gui/SketchPlugin/images/Fillet.png b/doc/gui/SketchPlugin/images/Fillet.png
new file mode 100644 (file)
index 0000000..8abbb81
Binary files /dev/null and b/doc/gui/SketchPlugin/images/Fillet.png differ
diff --git a/doc/gui/SketchPlugin/images/Intersection.png b/doc/gui/SketchPlugin/images/Intersection.png
new file mode 100644 (file)
index 0000000..9382871
Binary files /dev/null and b/doc/gui/SketchPlugin/images/Intersection.png differ
diff --git a/doc/gui/SketchPlugin/images/Line.png b/doc/gui/SketchPlugin/images/Line.png
new file mode 100644 (file)
index 0000000..2f48eee
Binary files /dev/null and b/doc/gui/SketchPlugin/images/Line.png differ
diff --git a/doc/gui/SketchPlugin/images/Point.png b/doc/gui/SketchPlugin/images/Point.png
new file mode 100644 (file)
index 0000000..c4691b6
Binary files /dev/null and b/doc/gui/SketchPlugin/images/Point.png differ
diff --git a/doc/gui/SketchPlugin/images/Projection.png b/doc/gui/SketchPlugin/images/Projection.png
new file mode 100644 (file)
index 0000000..403cc74
Binary files /dev/null and b/doc/gui/SketchPlugin/images/Projection.png differ
diff --git a/doc/gui/SketchPlugin/images/Rectangle.png b/doc/gui/SketchPlugin/images/Rectangle.png
new file mode 100644 (file)
index 0000000..2bb9f91
Binary files /dev/null and b/doc/gui/SketchPlugin/images/Rectangle.png differ
diff --git a/doc/gui/SketchPlugin/images/SketchProperties.png b/doc/gui/SketchPlugin/images/SketchProperties.png
new file mode 100644 (file)
index 0000000..e3f3991
Binary files /dev/null and b/doc/gui/SketchPlugin/images/SketchProperties.png differ
diff --git a/doc/gui/SketchPlugin/images/Split.png b/doc/gui/SketchPlugin/images/Split.png
new file mode 100644 (file)
index 0000000..871ce3b
Binary files /dev/null and b/doc/gui/SketchPlugin/images/Split.png differ
diff --git a/doc/gui/SketchPlugin/images/StartSketch.png b/doc/gui/SketchPlugin/images/StartSketch.png
new file mode 100644 (file)
index 0000000..3039b3f
Binary files /dev/null and b/doc/gui/SketchPlugin/images/StartSketch.png differ
diff --git a/doc/gui/SketchPlugin/images/Trim.png b/doc/gui/SketchPlugin/images/Trim.png
new file mode 100644 (file)
index 0000000..ac76466
Binary files /dev/null and b/doc/gui/SketchPlugin/images/Trim.png differ
diff --git a/doc/gui/SketchPlugin/intersectionFeature.rst b/doc/gui/SketchPlugin/intersectionFeature.rst
new file mode 100644 (file)
index 0000000..d48c825
--- /dev/null
@@ -0,0 +1,3 @@
+
+Intersection
+============
diff --git a/doc/gui/SketchPlugin/lengthFeature.rst b/doc/gui/SketchPlugin/lengthFeature.rst
new file mode 100644 (file)
index 0000000..3b5ab83
--- /dev/null
@@ -0,0 +1,3 @@
+
+Length constraint
+=================
diff --git a/doc/gui/SketchPlugin/lineFeature.rst b/doc/gui/SketchPlugin/lineFeature.rst
new file mode 100644 (file)
index 0000000..d50a2f6
--- /dev/null
@@ -0,0 +1,3 @@
+
+Line
+====
diff --git a/doc/gui/SketchPlugin/middleFeature.rst b/doc/gui/SketchPlugin/middleFeature.rst
new file mode 100644 (file)
index 0000000..3f7b91f
--- /dev/null
@@ -0,0 +1,3 @@
+
+Middle constraint
+=================
diff --git a/doc/gui/SketchPlugin/mirrorFeature.rst b/doc/gui/SketchPlugin/mirrorFeature.rst
new file mode 100644 (file)
index 0000000..deb91a3
--- /dev/null
@@ -0,0 +1,3 @@
+
+Mirror
+======
diff --git a/doc/gui/SketchPlugin/parallelFeature.rst b/doc/gui/SketchPlugin/parallelFeature.rst
new file mode 100644 (file)
index 0000000..77d0326
--- /dev/null
@@ -0,0 +1,3 @@
+
+Parallel constraint
+===================
diff --git a/doc/gui/SketchPlugin/perpendicularFeature.rst b/doc/gui/SketchPlugin/perpendicularFeature.rst
new file mode 100644 (file)
index 0000000..43a955d
--- /dev/null
@@ -0,0 +1,3 @@
+
+Perpendicular constraint
+========================
diff --git a/doc/gui/SketchPlugin/pointFeature.rst b/doc/gui/SketchPlugin/pointFeature.rst
new file mode 100644 (file)
index 0000000..64f21b1
--- /dev/null
@@ -0,0 +1,3 @@
+
+Point
+=====
diff --git a/doc/gui/SketchPlugin/projectionFeature.rst b/doc/gui/SketchPlugin/projectionFeature.rst
new file mode 100644 (file)
index 0000000..babf395
--- /dev/null
@@ -0,0 +1,3 @@
+
+Projection
+==========
diff --git a/doc/gui/SketchPlugin/radiusFeature.rst b/doc/gui/SketchPlugin/radiusFeature.rst
new file mode 100644 (file)
index 0000000..c8a04be
--- /dev/null
@@ -0,0 +1,3 @@
+
+Radius constraint
+=================
diff --git a/doc/gui/SketchPlugin/rigidFeature.rst b/doc/gui/SketchPlugin/rigidFeature.rst
new file mode 100644 (file)
index 0000000..1fcef1a
--- /dev/null
@@ -0,0 +1,3 @@
+
+Rigid constraint
+================
diff --git a/doc/gui/SketchPlugin/rotationFeature.rst b/doc/gui/SketchPlugin/rotationFeature.rst
new file mode 100644 (file)
index 0000000..daaa47a
--- /dev/null
@@ -0,0 +1,3 @@
+
+Rotation
+========
diff --git a/doc/gui/SketchPlugin/sketchPlugin.rst b/doc/gui/SketchPlugin/sketchPlugin.rst
new file mode 100644 (file)
index 0000000..59a6938
--- /dev/null
@@ -0,0 +1,72 @@
+
+.. _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
diff --git a/doc/gui/SketchPlugin/splitFeature.rst b/doc/gui/SketchPlugin/splitFeature.rst
new file mode 100644 (file)
index 0000000..ad36430
--- /dev/null
@@ -0,0 +1,3 @@
+
+Split
+=====
diff --git a/doc/gui/SketchPlugin/tangentFeature.rst b/doc/gui/SketchPlugin/tangentFeature.rst
new file mode 100644 (file)
index 0000000..2ddc420
--- /dev/null
@@ -0,0 +1,3 @@
+
+Tangent constraint
+==================
diff --git a/doc/gui/SketchPlugin/translationFeature.rst b/doc/gui/SketchPlugin/translationFeature.rst
new file mode 100644 (file)
index 0000000..730589c
--- /dev/null
@@ -0,0 +1,3 @@
+
+Translation
+===========
diff --git a/doc/gui/SketchPlugin/trimFeature.rst b/doc/gui/SketchPlugin/trimFeature.rst
new file mode 100644 (file)
index 0000000..7c9c2ce
--- /dev/null
@@ -0,0 +1,3 @@
+
+Trim
+====
diff --git a/doc/gui/SketchPlugin/verticalDistFeature.rst b/doc/gui/SketchPlugin/verticalDistFeature.rst
new file mode 100644 (file)
index 0000000..5a98df3
--- /dev/null
@@ -0,0 +1,3 @@
+
+Vertical distance constraint
+============================
diff --git a/doc/gui/SketchPlugin/verticalFeature.rst b/doc/gui/SketchPlugin/verticalFeature.rst
new file mode 100644 (file)
index 0000000..4b705ef
--- /dev/null
@@ -0,0 +1,3 @@
+
+Vertical constraint
+===================
index 68f3d4860625e9102c3509c4aaa4b5e5e6cd3081..8d222a1d755a8e16d3a5aa5aab1f008d7d65e9c6 100644 (file)
@@ -16,8 +16,8 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-import os
-import sys
+import os
+import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = []
+extensions = ['sphinx.ext.autodoc','sphinx.ext.autosummary']
+try:
+  import sphinxcontrib.napoleon
+  extensions += ['sphinxcontrib.napoleon']
+except:
+  pass
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = [os.path.join('@CMAKE_CURRENT_SOURCE_DIR@','templates')]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
@@ -47,7 +52,9 @@ master_doc = 'index'
 # General information about the project.
 project = u'SHAPER'
 copyright = u'2014-2017  CEA/DEN, EDF R&D'
-author = u'vsv'
+
+# Copyright is shown via custom footer
+html_show_copyright = False
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -63,7 +70,7 @@ release = u'3.0.0'
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+#language = None
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -74,7 +81,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 pygments_style = 'sphinx'
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
-todo_include_todos = False
+todo_include_todos = False
 
 
 # -- Options for HTML output ----------------------------------------------
@@ -82,7 +89,7 @@ todo_include_todos = False
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = '@SPHINX_THEME@'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -93,7 +100,7 @@ html_theme = 'alabaster'
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = [os.path.join('@CMAKE_CURRENT_BINARY_DIR@','static')]
 
 
 # -- Options for HTMLHelp output ------------------------------------------
@@ -104,23 +111,17 @@ htmlhelp_basename = 'SHAPERdoc'
 
 # -- Options for LaTeX output ---------------------------------------------
 
-latex_elements = {
-    # The paper size ('letterpaper' or 'a4paper').
-    #
-    # 'papersize': 'letterpaper',
-
-    # The font size ('10pt', '11pt' or '12pt').
-    #
-    # 'pointsize': '10pt',
+# The paper size ('letter' or 'a4').
+latex_paper_size = 'a4'
 
-    # Additional stuff for the LaTeX preamble.
-    #
-    # 'preamble': '',
+# The font size ('10pt', '11pt' or '12pt').
+latex_font_size = '10pt'
 
-    # Latex figure (float) alignment
-    #
-    # 'figure_align': 'htbp',
-}
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, document class [howto/manual]).
+latex_documents = [
+  ('index', 'SHAPER.tex', 'SHAPER User Documentation', '', 'manual'),
+]
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
@@ -135,10 +136,10 @@ latex_documents = [
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'shaper', u'SHAPER Documentation',
-     [author], 1)
-]
+#man_pages = [
+#    (master_doc, 'shaper', u'SHAPER Documentation',
+#     [author], 1)
+#]
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -146,8 +147,8 @@ man_pages = [
 # Grouping the document tree into Texinfo files. List of tuples
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
-texinfo_documents = [
-    (master_doc, 'SHAPER', u'SHAPER Documentation',
-     author, 'SHAPER', 'One line description of project.',
-     'Miscellaneous'),
-]
+#texinfo_documents = [
+#    (master_doc, 'SHAPER', u'SHAPER Documentation',
+#     author, 'SHAPER', 'One line description of project.',
+#     'Miscellaneous'),
+#]
index e43ee518be63ef1ac261f7ff1cf14b86392468de..cfa25b6a022bd44e6d5e9f41bb7cf2a179eaccae 100644 (file)
@@ -11,6 +11,7 @@ Welcome to SHAPER's documentation!
    :caption: Contents:
 
    FeaturesPlugin/featuresPlugin.rst
+   SketchPlugin/sketchPlugin.rst
 
 Indices and tables
 ==================
diff --git a/doc/gui/make.bat b/doc/gui/make.bat
deleted file mode 100644 (file)
index a3355b4..0000000
+++ /dev/null
@@ -1,36 +0,0 @@
-@ECHO OFF
-
-pushd %~dp0
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
-       set SPHINXBUILD=sphinx-build
-)
-set SOURCEDIR=.
-set BUILDDIR=_build
-set SPHINXPROJ=SHAPER
-
-if "%1" == "" goto help
-
-%SPHINXBUILD% >NUL 2>NUL
-if errorlevel 9009 (
-       echo.
-       echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
-       echo.installed, then set the SPHINXBUILD environment variable to point
-       echo.to the full path of the 'sphinx-build' executable. Alternatively you
-       echo.may add the Sphinx directory to PATH.
-       echo.
-       echo.If you don't have Sphinx installed, grab it from
-       echo.http://sphinx-doc.org/
-       exit /b 1
-)
-
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
-goto end
-
-:help
-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
-
-:end
-popd
diff --git a/doc/gui/static/switchers.js.in b/doc/gui/static/switchers.js.in
new file mode 100644 (file)
index 0000000..8595b5c
--- /dev/null
@@ -0,0 +1,72 @@
+(function() {
+  'use strict';
+
+  // Parses versions in URL segments like:
+
+  var all_languages = {
+      'en': 'English',
+      'fr': 'French',
+  };
+
+  function build_language_select(current_language) {
+    var buf = ['<select>'];
+
+    $.each(all_languages, function(language, title) {
+      if (language == current_language)
+        buf.push('<option value="' + language + '" selected="selected">' +
+                 all_languages[current_language] + '</option>');
+      else
+        buf.push('<option value="' + language + '">' + title + '</option>');
+    });
+    buf.push('</select>');
+    return buf.join('');
+  }
+
+  function on_language_switch() {
+    var selected_language = $(this).children('option:selected').attr('value') + '/';
+    var url = window.location.href;
+
+    var current_language = language_segment_from_url(url);
+    var current_suffix = "";
+    if (current_language != "") {
+      current_suffix = "_";
+    } else {
+       current_language = "/";
+    }
+
+    var selected_suffix = "_";
+    if (selected_language == 'en/') { // Special 'default' case for english.
+      selected_language = '';
+      selected_suffix = "/";
+    }
+
+    var new_url = url.replace('/gui/SMESH' + current_suffix + current_language,
+                              '/gui/SMESH' + selected_suffix + selected_language);
+    if (new_url != url) {
+      window.location.href = new_url;
+    }
+  }
+
+  // Returns the path segment of the language as a string, like 'fr/'
+  // or '' if not found.
+  function language_segment_from_url(url) {
+    var language_regexp = '\/gui/SMESH_([a-z]{2}(?:-[a-z]{2})?/)';
+    var match = url.match(language_regexp);
+    if (match !== null)
+        return match[1];
+    return '';
+  }
+
+  $(document).ready(function() {
+    if(@BUILD_LANGUAGE_SWITCHER@) {
+       var release = DOCUMENTATION_OPTIONS.VERSION;
+       var language_segment = language_segment_from_url(window.location.href);
+       var current_language = language_segment.replace(/\/+$/g, '') || 'English';
+
+       var language_select = build_language_select(current_language);
+
+       $('.language_switcher_placeholder').html(language_select);
+       $('.language_switcher_placeholder select').bind('change', on_language_switch);
+    }
+  });
+})();
diff --git a/doc/gui/templates/layout.html b/doc/gui/templates/layout.html
new file mode 100644 (file)
index 0000000..94d467b
--- /dev/null
@@ -0,0 +1,30 @@
+{% extends "!layout.html" %}
+
+{% block rootrellink %}
+  <span class="language_switcher_placeholder">{{ language or 'English' }}</span>
+  {{ super() }}
+{% endblock %}
+
+{% block extrahead %}
+<script type="text/javascript" src="{{ pathto('_static/switchers.js', 1) }}"></script>
+{{ super() }}
+{% endblock %}
+
+{%- block sidebarlogo %}
+{{ super() }}
+{%-
+include "searchbox.html"
+%}
+<p/>
+{%- endblock %}
+{%- block sidebarsearch %}
+{%- endblock %}
+
+{%- block footer %}
+ <div class="footer">
+         &copy; Copyright 2007-2017, CEA/DEN, EDF R&amp;D, OPEN CASCADE
+         <br>
+         &copy; Copyright 2003-2007, OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&amp;D, LEG, PRINCIPIA R&amp;D, BUREAU VERITAS.
+ </div>
+ {{ super() }}
+{%- endblock %}
index 138c0a60b2d701aeaa2987151a7a4f58e1d2ad42..72e0ef18176ef33f4d593a26c5ce53f34145c5b7 100644 (file)
@@ -40,7 +40,8 @@ email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com
         when_nested="accept abort"
         title="Sketch"
         tooltip="Create sketch"
-        icon="icons/Sketch/sketch.png">
+        icon="icons/Sketch/sketch.png"
+        helpfile="SketchPlugin/sketchPlugin.html">
         <sketch-start-label id="External" title="Select a plane on which to create a sketch" tooltip="Select a plane on which to create a sketch">
           <validator id="GeomValidators_Face" parameters="plane"/>
         </sketch-start-label>
@@ -50,14 +51,16 @@ email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com
       </feature>
 
       <!-- SketchPoint -->
-      <feature id="SketchPoint" title="Point" tooltip="Create point" icon="icons/Sketch/point.png">
+      <feature id="SketchPoint" title="Point" tooltip="Create point" icon="icons/Sketch/point.png"
+                helpfile="SketchPlugin/pointFeature.html">
         <sketch-2dpoint_selector id="PointCoordinates" accept_expressions="0" title="Point" tooltip="Point coordinates"
                                  enable_value="enable_by_preferences"/>
         <boolvalue id="Auxiliary" label="Auxiliary" default="false" tooltip="Construction element" obligatory="0"/>
       </feature>
 
       <!-- SketchLine -->
-      <feature id="SketchLine" title="Line" tooltip="Create line" icon="icons/Sketch/line.png">
+      <feature id="SketchLine" title="Line" tooltip="Create line" icon="icons/Sketch/line.png"
+               helpfile="SketchPlugin/lineFeature.html">
         <sketch-2dpoint_selector id="StartPoint" accept_expressions="0" title="Start point" tooltip="Start point coordinates"
                                  enable_value="enable_by_preferences"/>
         <sketch-2dpoint_selector id="EndPoint" accept_expressions="0" title="End point" tooltip="End point coordinates"
@@ -94,7 +97,8 @@ email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com
       <feature id="SketchMacroCircle"
                icon="icons/Sketch/circle.png"
                title="Circle"
-               tooltip="Create circle">
+               tooltip="Create circle"
+               helpfile="SketchPlugin/circleFeature.html">
         <toolbox id="circle_type" modified_in_edit="edit_circle_type">
           <box id="circle_type_by_center_and_passed_points"
                icon="icons/Sketch/circle_pt_rad_32x32.png"
@@ -213,7 +217,8 @@ email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com
         id="SketchMacroArc"
         title="Arc"
         tooltip="Create arc"
-        icon="icons/Sketch/arc.png">
+        icon="icons/Sketch/arc.png"
+        helpfile="SketchPlugin/arcFeature.html">
         <toolbox id="arc_type" modified_in_edit="edit_arc_type">
           <box id="by_center_and_points"
                icon="icons/Sketch/arc_base_32x32.png"
@@ -318,7 +323,8 @@ email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com
       <feature id="SketchFillet"
                title="Fillet"
                tooltip="Create constraint defining fillet between two objects"
-               icon="icons/Sketch/fillet.png">
+               icon="icons/Sketch/fillet.png"
+               helpfile="SketchPlugin/filletFeature.html">
         <sketch_shape_selector id="fillet_point"
                                label="Point"
                                tooltip="Select point for fillet (should be shared by two entities only)"
@@ -330,7 +336,8 @@ email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com
       <!--  SketchSplit  -->
       <feature id="SketchSplit" title="Split"
                tooltip="Cut selected segment arc or circle on existing coincident points"
-               icon="icons/Sketch/split.png">
+               icon="icons/Sketch/split.png"
+               helpfile="SketchPlugin/splitFeature.html">
         <sketch_feature_point_selector
             id="SelectedObject"
             selection_attributes="SelectedObject SelectedPoint PreviewObject PreviewPoint"
@@ -345,7 +352,8 @@ email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com
       <!--  SketchTrim  -->
       <feature id="SketchTrim" title="Trim"
                tooltip="Trim selected segment arc or circle on intersection points nearest to the graphic selection"
-               icon="icons/Sketch/trim.png">
+               icon="icons/Sketch/trim.png"
+               helpfile="SketchPlugin/trimFeature.html">
         <sketch_feature_point_selector
             id="SelectedObject"
             selection_attributes="SelectedObject SelectedPoint PreviewObject PreviewPoint"
@@ -399,7 +407,8 @@ email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com
       <feature id="SketchMacroEllipse"
                icon="icons/Sketch/ellipse.png"
                title="Ellipse"
-               tooltip="Create ellipse">
+               tooltip="Create ellipse"
+               helpfile="SketchPlugin/ellipseFeature.html">
         <sketch-2dpoint_selector id="center_point"
                                  reference_attribute="center_point_ref"
                                  title="Center point"
@@ -456,7 +465,8 @@ email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com
         id="SketchProjection"
         title="Projection"
         tooltip="Project feature onto sketch plane"
-        icon="icons/Sketch/projection.png">
+        icon="icons/Sketch/projection.png"
+        helpfile="SketchPlugin/projectionFeature.html">
         <sketch_shape_selector
               id="ExternalFeature"
               label="Object"
@@ -476,7 +486,8 @@ email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com
         id="SketchIntersectionPoint"
         title="Intersection"
         tooltip="Intersect edge with sketch plane"
-        icon="icons/Sketch/intersection.png">
+        icon="icons/Sketch/intersection.png"
+        helpfile="SketchPlugin/intersectionFeature.html">
         <sketch_shape_selector
               id="ExternalFeature"
               label="Object"
@@ -497,7 +508,8 @@ email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com
       <feature
         id="SketchConstraintMirror"
         title="Mirror copy" icon="icons/Sketch/mirror.png"
-        tooltip="Create constraint, mirroring group of objects">
+        tooltip="Create constraint, mirroring group of objects"
+        helpfile="SketchPlugin/mirrorFeature.html">
         <sketch_shape_selector id="ConstraintEntityA"
             label="Mirror line" tooltip="Select mirror line" shape_types="edge">
           <validator id="GeomValidators_ShapeType" parameters="line"/>
@@ -518,7 +530,8 @@ email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com
       <feature
         id="SketchMultiTranslation"
         title="Linear copy" icon="icons/Sketch/translate.png"
-        tooltip="Copy objects and move">
+        tooltip="Copy objects and move"
+        helpfile="SketchPlugin/translationFeature.html">
         <sketch_multi_selector id="MultiTranslationList"
             label="Segments:"
             tooltip="Select list of objects to be translated"
@@ -586,7 +599,8 @@ email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com
       <feature
         id="SketchMultiRotation"
         title="Angular copy" icon="icons/Sketch/rotate.png"
-        tooltip="Copy objects and rotate">
+        tooltip="Copy objects and rotate"
+        helpfile="SketchPlugin/rotationFeature.html">
         <sketch_multi_selector id="MultiRotationList"
             label="Segments:"
             tooltip="Select list of objects to be rotated"
@@ -651,7 +665,8 @@ email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com
         id="SketchConstraintDistance"
         title="Distance"
         tooltip="Set fixed distance from a point to an object"
-        icon="icons/Sketch/distance.png">
+        icon="icons/Sketch/distance.png"
+        helpfile="SketchPlugin/distanceFeature.html">
         <label title="Select objects for distance definition. Following objects can be accepted: point, line or arc end point, center of circle or arc."/>
         <sketch_shape_selector
               id="ConstraintEntityA"
@@ -699,7 +714,8 @@ email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com
         id="SketchConstraintDistanceHorizontal"
         title="Horizontal Distance"
         tooltip="Set horizontal distance between two points"
-        icon="icons/Sketch/distance_h.png">
+        icon="icons/Sketch/distance_h.png"
+        helpfile="SketchPlugin/horizontalDistFeature.html">
         <label title="Select points for distance definition."/>
         <sketch_shape_selector
               id="ConstraintEntityA"
@@ -743,7 +759,8 @@ email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com
         id="SketchConstraintDistanceVertical"
         title="Vertical Distance"
         tooltip="Set vertical distance between two points"
-        icon="icons/Sketch/distance_v.png">
+        icon="icons/Sketch/distance_v.png"
+        helpfile="SketchPlugin/verticalDistFeature.html">
         <label title="Select points for distance definition."/>
         <sketch_shape_selector
               id="ConstraintEntityA"
@@ -783,7 +800,8 @@ email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com
       </feature>
 
       <!--  SketchConstraintLength  -->
-      <feature id="SketchConstraintLength" title="Length" tooltip="Set fixed length of a line segment" icon="icons/Sketch/length.png">
+      <feature id="SketchConstraintLength" title="Length" tooltip="Set fixed length of a line segment" icon="icons/Sketch/length.png"
+               helpfile="SketchPlugin/lengthFeature.html">
         <label title="Select a line on which to calculate length" tooltip="Select a line on which to calculate length"/>
         <shape_selector id="ConstraintEntityA" label="Line" tooltip="Select a line" shape_types="edge" >
           <validator id="GeomValidators_ShapeType" parameters="line"/>
@@ -806,7 +824,8 @@ email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com
       </feature>
 
       <!--  SketchConstraintAngle  -->
-      <feature id="SketchConstraintAngle" title="Angle" tooltip="Set fixed angle between two line segments" icon="icons/Sketch/angle_constr.png">
+      <feature id="SketchConstraintAngle" title="Angle" tooltip="Set fixed angle between two line segments" icon="icons/Sketch/angle_constr.png"
+               helpfile="SketchPlugin/angleFeature.html">
         <sketch_shape_selector id="ConstraintEntityA" label="Line 1" tooltip="Select a line" shape_types="edge" >
           <validator id="GeomValidators_ShapeType" parameters="line"/>
           <validator id="PartSet_DifferentObjects"/>
@@ -843,7 +862,8 @@ email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com
       </feature>
 
       <!--  SketchConstraintRadius  -->
-      <feature id="SketchConstraintRadius" title="Radius" tooltip="Set fixed radius of a circle or an arc" icon="icons/Sketch/radius_constr.png">
+      <feature id="SketchConstraintRadius" title="Radius" tooltip="Set fixed radius of a circle or an arc" icon="icons/Sketch/radius_constr.png"
+               helpfile="SketchPlugin/radiusFeature.html">
         <label title="Select a circle or an arc on which to calculate radius" tooltip="Select a circle or an arc on which to calculate radius"/>
         <shape_selector id="ConstraintEntityA" label="Circle or Arc" tooltip="Select a circle or an arc"
             shape_types="edge">
@@ -872,7 +892,8 @@ email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com
     <group id="Geometrical constraints">
 
       <!--  SketchConstraintHorizontal  -->
-      <feature id="SketchConstraintHorizontal" title="Horizontal" tooltip="Create constraint defining horizontal line" icon="icons/Sketch/horisontal.png">
+      <feature id="SketchConstraintHorizontal" title="Horizontal" tooltip="Create constraint defining horizontal line" icon="icons/Sketch/horisontal.png"
+               helpfile="SketchPlugin/horizontalFeature.html">
         <sketch_shape_selector id="ConstraintEntityA"
             label="Line" tooltip="Select a line" shape_types="edge" use_external="false">
           <validator id="GeomValidators_ShapeType" parameters="line"/>
@@ -882,7 +903,8 @@ email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com
       </feature>
 
       <!--  SketchConstraintVertical  -->
-      <feature id="SketchConstraintVertical" title="Vertical" tooltip="Create constraint defining vertical line" icon="icons/Sketch/vertical.png">
+      <feature id="SketchConstraintVertical" title="Vertical" tooltip="Create constraint defining vertical line" icon="icons/Sketch/vertical.png"
+               helpfile="SketchPlugin/verticalFeature.html">
         <sketch_shape_selector id="ConstraintEntityA"
             label="Line" tooltip="Select a line" shape_types="edge" use_external="false">
           <validator id="GeomValidators_ShapeType" parameters="line"/>
@@ -892,7 +914,8 @@ email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com
       </feature>
 
       <!--  SketchConstraintRigid  -->
-      <feature id="SketchConstraintRigid" title="Fixed" tooltip="Fix an object" icon="icons/Sketch/fixed.png">
+      <feature id="SketchConstraintRigid" title="Fixed" tooltip="Fix an object" icon="icons/Sketch/fixed.png"
+               helpfile="SketchPlugin/rigidFeature.html">
         <sketch_shape_selector id="ConstraintEntityA" label="Object"
                         tooltip="Select point, line end point, line, center of circle or arc."
                         shape_types="edge vertex">
@@ -904,7 +927,7 @@ email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com
 
       <!--  SketchConstraintParallel  -->
       <feature id="SketchConstraintParallel" title="Parallel" tooltip="Create constraint defining two parallel lines"
-               icon="icons/Sketch/parallel.png">
+               icon="icons/Sketch/parallel.png" helpfile="SketchPlugin/parallelFeature.html">
         <sketch_shape_selector id="ConstraintEntityA"
             label="First line" tooltip="Select a line" shape_types="edge">
           <validator id="GeomValidators_ShapeType" parameters="line"/>
@@ -923,8 +946,9 @@ email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com
 
     <!--  SketchConstraintPerpendicular  -->
       <feature id="SketchConstraintPerpendicular" title="Perpendicular"
-        tooltip="Create constraint defining two perpendicular lines"
-        icon="icons/Sketch/perpendicular.png">
+               tooltip="Create constraint defining two perpendicular lines"
+               icon="icons/Sketch/perpendicular.png"
+               helpfile="SketchPlugin/perpendicularFeature.html">
         <sketch_shape_selector id="ConstraintEntityA"
             label="First line" tooltip="Select a line"
             shape_types="edge">
@@ -944,7 +968,8 @@ email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com
       </feature>
 
       <!--  SketchConstraintTangent  -->
-      <feature id="SketchConstraintTangent" title="Tangent" tooltip="Create constraint defining tangency of two objects with common coincident point" icon="icons/Sketch/tangent.png">
+      <feature id="SketchConstraintTangent" title="Tangent" tooltip="Create constraint defining tangency of two objects with common coincident point" icon="icons/Sketch/tangent.png"
+               helpfile="SketchPlugin/tangentFeature.html">
         <sketch_shape_selector id="ConstraintEntityA"
             label="First object" tooltip="Select line or arc" shape_types="edge">
           <validator id="SketchPlugin_TangentAttr" parameters="ConstraintEntityB"/>
@@ -960,7 +985,8 @@ email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com
       </feature>
 
       <!--  SketchConstraintCoincidence  -->
-      <feature id="SketchConstraintCoincidence" title="Coincident" tooltip="Create constraint for the coincidence of two points or point on line or circle" icon="icons/Sketch/coincedence.png">
+      <feature id="SketchConstraintCoincidence" title="Coincident" tooltip="Create constraint for the coincidence of two points or point on line or circle" icon="icons/Sketch/coincedence.png"
+               helpfile="SketchPlugin/coincedenceFeature.html">
         <sketch_shape_selector id="ConstraintEntityA" label="First object" tooltip="Select a first object" shape_types="vertex edge">
           <validator id="PartSet_DifferentObjects"/>
           <validator id="SketchPlugin_ExternalValidator" parameters="ConstraintEntityB"/>
@@ -974,7 +1000,9 @@ email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com
       </feature>
 
       <!--  SketchConstraintMiddle  -->
-      <feature id="SketchConstraintMiddle" title="Middle point" tooltip="Create constraint for setting middle point on a line" icon="icons/Sketch/middlepoint.png">
+      <feature id="SketchConstraintMiddle" title="Middle point" tooltip="Create constraint for setting middle point on a line"
+               icon="icons/Sketch/middlepoint.png"
+               helpfile="SketchPlugin/middleFeature.html">
         <sketch_shape_selector id="ConstraintEntityA" label="First object" tooltip="Select a first object" shape_types="vertex edge">
           <validator id="PartSet_DifferentObjects"/>
           <validator id="SketchPlugin_ExternalValidator" parameters="ConstraintEntityB"/>
@@ -991,7 +1019,8 @@ email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com
       <!--  SketchConstraintEqual  -->
       <feature id="SketchConstraintEqual" title="Equal"
         tooltip="Create constraint defining equal lengths of two lines or line and arc or equal radii of two arcs or two circles or arc and circle"
-        icon="icons/Sketch/equal.png">
+        icon="icons/Sketch/equal.png"
+               helpfile="SketchPlugin/equalFeature.html">
         <sketch_shape_selector id="ConstraintEntityA"
             label="First object" tooltip="Select line, circle or arc" shape_types="edge">
           <validator id="PartSet_DifferentObjects"/>
@@ -1008,7 +1037,9 @@ email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com
       </feature>
 
     <!--  SketchConstraintCollinear  -->
-      <feature id="SketchConstraintCollinear" title="Collinear" tooltip="Create constraint defining collinearity of two lines" icon="icons/Sketch/collinear.png">
+      <feature id="SketchConstraintCollinear" title="Collinear" tooltip="Create constraint defining collinearity of two lines"
+               icon="icons/Sketch/collinear.png"
+               helpfile="SketchPlugin/collinearFeature.html">
         <sketch_shape_selector id="ConstraintEntityA"
             label="First line" tooltip="Select a line" shape_types="edge">
           <validator id="GeomValidators_ShapeType" parameters="line"/>