]> SALOME platform Git repositories - modules/eficas.git/commitdiff
Salome HOME
Integrate doc in Salome
authorRenaud Barate <renaud.barate@edf.fr>
Thu, 24 Nov 2011 13:37:34 +0000 (13:37 +0000)
committerRenaud Barate <renaud.barate@edf.fr>
Thu, 24 Nov 2011 13:37:34 +0000 (13:37 +0000)
Makefile.in
configure.in
configure.in.base
doc/Makefile [deleted file]
doc/Makefile.in
doc/conf.py
doc/eficas_for_OpenTurns.rst [deleted file]
doc/index.rst
doc/patchEficasV1_10.diff [deleted file]
resources/SalomeApp.xml

index 2e53d0975a2294d24a1b26b663852246f8fe0d7b..b0e5a11646c31de87754f9a9c0e7675f0de58fc2 100644 (file)
@@ -13,7 +13,7 @@ VPATH=.:@srcdir@:@top_srcdir@/bin:@top_srcdir@/resources:./bin:@top_srcdir@/idl
 
 @COMMENCE@
 
-SUBDIRS = idl src 
+SUBDIRS = idl src doc
 
 RESOURCES_FILES = \
 EFICASCatalog.xml \
index 6ff06f362a725ddab88f8656e8ab59a5f18ad7e2..7c2add102e699542df446c6757f504f9ade1c57c 100644 (file)
@@ -152,8 +152,22 @@ echo Summary
 echo ---------------------------------------------
 echo
 
+echo
+echo ---------------------------------------------
+echo Testing Sphinx
+echo ---------------------------------------------
+echo
+
+CHECK_SPHINX
+
+echo
+echo ---------------------------------------------
+echo Summary
+echo ---------------------------------------------
+echo
+
 echo Configure
-variables="python_ok threads_ok OpenGL_ok qt_ok omniORB_ok Kernel_ok  SalomeGUI_ok"
+variables="python_ok threads_ok OpenGL_ok qt_ok omniORB_ok Kernel_ok SalomeGUI_ok sphinx_ok"
 
 for var in $variables
 do
index 46f5ed04d580916b3c65ab361e803805b5ac39b2..d6adbe0734214174bf20c8791e2f8d365c1d7a31 100644 (file)
@@ -152,8 +152,22 @@ echo Summary
 echo ---------------------------------------------
 echo
 
+echo
+echo ---------------------------------------------
+echo Testing Sphinx
+echo ---------------------------------------------
+echo
+
+CHECK_SPHINX
+
+echo
+echo ---------------------------------------------
+echo Summary
+echo ---------------------------------------------
+echo
+
 echo Configure
-variables="python_ok threads_ok OpenGL_ok qt_ok omniORB_ok Kernel_ok  SalomeGUI_ok"
+variables="python_ok threads_ok OpenGL_ok qt_ok omniORB_ok Kernel_ok SalomeGUI_ok sphinx_ok"
 
 for var in $variables
 do
diff --git a/doc/Makefile b/doc/Makefile
deleted file mode 100644 (file)
index 0b09677..0000000
+++ /dev/null
@@ -1,70 +0,0 @@
-# Makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line.
-SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
-PAPER         =
-
-# Internal variables.
-PAPEROPT_a4     = -D latex_paper_size=a4
-PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS   = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
-
-.PHONY: help clean html web pickle htmlhelp latex changes linkcheck
-
-help:
-       @echo "Please use \`make <target>' where <target> is one of"
-       @echo "  html      to make standalone HTML files"
-       @echo "  pickle    to make pickle files (usable by e.g. sphinx-web)"
-       @echo "  htmlhelp  to make HTML files and a HTML help project"
-       @echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
-       @echo "  changes   to make an overview over all changed/added/deprecated items"
-       @echo "  linkcheck to check all external links for integrity"
-
-clean:
-       -rm -rf build/*
-
-html:
-       mkdir -p build/html build/doctrees
-       $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
-       @echo
-       @echo "Build finished. The HTML pages are in build/html."
-
-pickle:
-       mkdir -p build/pickle build/doctrees
-       $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle
-       @echo
-       @echo "Build finished; now you can process the pickle files or run"
-       @echo "  sphinx-web build/pickle"
-       @echo "to start the sphinx-web server."
-
-web: pickle
-
-htmlhelp:
-       mkdir -p build/htmlhelp build/doctrees
-       $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp
-       @echo
-       @echo "Build finished; now you can run HTML Help Workshop with the" \
-             ".hhp project file in build/htmlhelp."
-
-latex:
-       mkdir -p build/latex build/doctrees
-       $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex
-       @echo
-       @echo "Build finished; the LaTeX files are in build/latex."
-       @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
-             "run these through (pdf)latex."
-
-changes:
-       mkdir -p build/changes build/doctrees
-       $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes
-       @echo
-       @echo "The overview file is in build/changes."
-
-linkcheck:
-       mkdir -p build/linkcheck build/doctrees
-       $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck
-       @echo
-       @echo "Link check complete; look for any errors in the above output " \
-             "or in build/linkcheck/output.txt."
index 069960a6f7968b5515898fd02790289804bf0364..924f71ba3f37b65134c0e3cb361ab38db272d8bc 100644 (file)
@@ -1,32 +1,55 @@
-
-# -* Makefile *- 
+#  Copyright (C) 2011 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.
+#
+#  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.
 #
-# Author : Patrick GOLDBRONN (CEA)
-# Date : 30/11/2001
+#  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
 #
-# source path
-top_srcdir=@top_srcdir@
-top_builddir=..
+#  See http://www.salome-platform.org/ or
+#  email : webmaster.salome@opencascade.com
+#
+
 srcdir=@srcdir@
-VPATH=.:@srcdir@
+eficasdocdir=@prefix@/share/doc/salome/gui/EFICAS
+INSTALL=@INSTALL@
 
-SUBDIRS=
+SPHINXOPTS      =
+SOURCEDIR       = $(srcdir)
+SPHINXBUILD     = sphinx-build
+PAPEROPT_a4     = -D latex_paper_size=a4
+ALLSPHINXOPTS   = -d doctrees $(PAPEROPT_a4) $(SPHINXOPTS) $(SOURCEDIR)
 
 doc:
-       @@SETX@; for d in $(SUBDIRS); do        \
-          (cd $$d && $(MAKE) $@) || exit 1;    \
-       done
+       mkdir -p html doctrees
+       $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) html
+       @echo
+       @echo "Build finished. The HTML pages are in html."
+
+install:
+       if test -d "html"; then \
+               $(INSTALL) -d $(eficasdocdir); \
+               cp -rf $$b"html"/* $(eficasdocdir); \
+       fi
+
+uninstall:
+       chmod -R +w $(eficasdocdir)
+       rm -rf $(eficasdocdir)/*
+
 clean:
-       @@SETX@; for d in $(SUBDIRS); do        \
-          (cd $$d && $(MAKE) $@) || exit 1;    \
-       done
+       -rm -rf html doctrees
 
-distclean: clean
-       @@SETX@; for d in $(SUBDIRS); do        \
-          (cd $$d && $(MAKE) $@) || exit 1;    \
-       done
+resources:doc
 
-install:
-       @@SETX@; for d in $(SUBDIRS); do        \
-          (cd $$d && $(MAKE) $@) || exit 1;    \
-       done
+inc:
+depend:
+lib:
+bin:
index 0fa1e80c3a7d2bc627ac229b78aac24627ba9c90..0b233e4d276bd48774001f80484ee17ec7ddad2a 100644 (file)
@@ -104,7 +104,7 @@ html_style = 'default.css'
 # 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 = ['.static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
diff --git a/doc/eficas_for_OpenTurns.rst b/doc/eficas_for_OpenTurns.rst
deleted file mode 100644 (file)
index aa5d515..0000000
+++ /dev/null
@@ -1,3 +0,0 @@
-EFICAS for OpenTurns
-====================
-
index 5f26c58344f869750a2db672ef74fedaa7307722..04c3d8880eb6985cf15dda30412850d8e97f430c 100644 (file)
@@ -7,7 +7,9 @@ Welcome to EFICAS's documentation!
 
 This documentation covers the usage of Eficas as data setting tool in Salome. 
 This is intended for end users who want to use Eficas and not for developpers who want to write a catalog. 
-Refer to OpenTurns documentation to know more about Eficas specifications for this code.
+
+The usage of Eficas for OpenTURNS is not described in this guide. Refer to
+OpenTURNS module documentation to know how to use Eficas for this code.
 
 Contents:
 
diff --git a/doc/patchEficasV1_10.diff b/doc/patchEficasV1_10.diff
deleted file mode 100644 (file)
index 935874c..0000000
+++ /dev/null
@@ -1,26 +0,0 @@
-diff -Naur EficasV1_10AsterSTA8.orig/Editeur/panelsSalome.py EficasV1_10AsterSTA8/Editeur/panelsSalome.py
---- EficasV1_10AsterSTA8.orig/Editeur/panelsSalome.py  2006-06-20 16:41:50.000000000 +0200
-+++ EficasV1_10AsterSTA8/Editeur/panelsSalome.py       2006-07-18 17:44:45.000000000 +0200
-@@ -100,12 +100,20 @@
-       try: 
-         valeur,validite,commentaire=self.get_valeur()
-         #print 'add_valeur_plusieurs_base', name
--        #print 'valeur = %s, validite = %s,commentaire = %s'%( valeur,validite,commentaire )            
-+        #print 'valeur = %s, validite = %s,commentaire = %s'%( valeur,validite,commentaire )
-         if not valeur: # sélection dans salome        
-             #print 'CS_pbruno selection SALOME'
-             strSelection = ''
-             
--            selection, msg = self.parent.appli.selectGroupFromSalome()
-+            genea  = self.node.item.get_genealogie()            
-+            kwType = None
-+            for e in genea:
-+                if "GROUP_NO" in e:
-+                    kwType = "GROUP_NO"
-+                if "GROUP_MA" in e:
-+                    kwType = "GROUP_MA"            
-+                
-+            selection, msg = self.parent.appli.selectGroupFromSalome( kwType )
-             
-             #print 'CS_pbruno selection SALOME selection ->',selection
-             #print 'CS_pbruno selection SALOME msg ->',msg
index b1d5ea7d0ad2e55bff4c27e88b0a547e8738fbe7..24ec9af014f6f5aed914299f08a8593f87833551 100644 (file)
@@ -4,10 +4,15 @@
     <parameter name="name"    value="Eficas"/>
     <parameter name="icon"    value="eficas.png"/>
     <parameter name="library" value="SalomePyQtGUI"/>
-    <parameter name="version" value="6.3.1"/>
+    <parameter name="documentation" value="eficas_help"/>
+    <parameter name="version" value="6.4.0"/>
   </section>
   <section name="resources">
     <!-- Module resources -->
     <parameter name="EFICAS" value="%EFICAS_ROOT_DIR%/share/salome/resources/eficas"/>
   </section>
+  <section name="eficas_help">
+    <parameter name="sub_menu"     value="%1 module"/>
+    <parameter name="User's Guide" value="%EFICAS_ROOT_DIR%/share/doc/salome/gui/EFICAS/index.html"/>
+  </section>
 </document>