From: rnc <rnc@opencascade.com>
Date: Fri, 5 Apr 2013 16:04:30 +0000 (+0000)
Subject: - added the doc of the Yams plugin in the SALOME install
X-Git-Tag: pluginMGCleaner~7
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;ds=sidebyside;h=fe6504b34f85247cfd655436767a79b6c6810e40;p=modules%2Fsmesh.git

- added the doc of the Yams plugin in the SALOME install
- added an entry in the SMESH Plug-ins help menu
---

diff --git a/configure.ac b/configure.ac
index f51557152..b152c0465 100644
--- a/configure.ac
+++ b/configure.ac
@@ -576,6 +576,7 @@ AC_OUTPUT([ \
   src/Tools/Makefile \
   src/Tools/MeshCut/Makefile \
   src/Tools/YamsPlug/Makefile \
+  src/Tools/YamsPlug/doc/Makefile \
   src/Tools/padder/Makefile \
   src/Tools/padder/meshjob/Makefile \
   src/Tools/padder/meshjob/idl/Makefile \
diff --git a/resources/SalomeApp.xml.in b/resources/SalomeApp.xml.in
index fca22ab93..72f293f20 100644
--- a/resources/SalomeApp.xml.in
+++ b/resources/SalomeApp.xml.in
@@ -112,6 +112,7 @@
   <section name="smesh_help" >
     <parameter name="sub_menu"          value="%1 module"/>
     <parameter name="User's Guide"      value="%SMESH_ROOT_DIR%/share/doc/salome/gui/SMESH/index.html"/>
+    <parameter name="Plug-ins/Yams plugin User's Guide" value="%SMESH_ROOT_DIR%/share/doc/salome/gui/SMESH/yams/index.html"/>
     <parameter name="Developer's Guide" value="%SMESH_ROOT_DIR%/share/doc/salome/tui/SMESH/index.html"/>
   </section>
   <section name="resources">
diff --git a/src/Tools/YamsPlug/Makefile.am b/src/Tools/YamsPlug/Makefile.am
index 968b13e93..e1b8839d0 100644
--- a/src/Tools/YamsPlug/Makefile.am
+++ b/src/Tools/YamsPlug/Makefile.am
@@ -17,6 +17,8 @@
 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 #
 
+SUBDIRS = doc
+
 include $(top_srcdir)/adm_local/unix/make_common_starter.am
 
 UIPY_FILES = YamsPlugDialog.py  ViewText.py 
diff --git a/src/Tools/YamsPlug/doc/Makefile.am b/src/Tools/YamsPlug/doc/Makefile.am
new file mode 100644
index 000000000..9a9056a90
--- /dev/null
+++ b/src/Tools/YamsPlug/doc/Makefile.am
@@ -0,0 +1,61 @@
+# Makefile for Sphinx documentation
+#
+
+include $(top_srcdir)/adm_local/unix/make_common_starter.am
+
+yamsdocdir=$(docdir)/gui/SMESH/yams
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SOURCEDIR     = $(srcdir)
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCEDIR)
+
+.PHONY: help clean html latexpdf 
+
+all:
+	make html
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+install-data-local: all
+	test -z $(yamsdocdir) || mkdir -p $(yamsdocdir)
+	cp -rf $(BUILDDIR)/html/* $(yamsdocdir) ;
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+