From: prascle Date: Thu, 16 Feb 2006 21:36:24 +0000 (+0000) Subject: PR: generate user doc with target userdoc X-Git-Tag: BR_auto_V310__v_0_3~10 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=5baefc9c6d3b4734b7952c22897a4d476a7e5844;p=modules%2Fkernel.git PR: generate user doc with target userdoc --- diff --git a/Makefile.am b/Makefile.am index 061c84267..e8f17aa00 100644 --- a/Makefile.am +++ b/Makefile.am @@ -24,3 +24,6 @@ EXTRA_DIST = \ dist-hook: rm -rf `find $(distdir) -name CVS` + +userdoc: + (cd doc && $(MAKE) $(AM_MAKEFLAGS) userdoc) \ No newline at end of file diff --git a/doc/Makefile.am b/doc/Makefile.am index 50b096513..4d64132cc 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -5,9 +5,10 @@ # $Header$ # -#SUBDIRS = salome +include $(top_srcdir)/salome_adm/unix/make_common_starter.am + +SUBDIRS = salome -docdir = $(datadir)/doc doc_DATA = \ index.html \ UnitTests.html \ @@ -20,8 +21,11 @@ EXTRA_DIST=$(doc_DATA) # Building html from restructured text files STYLESHEET=rst.css RST2HTML=@RST2HTML@ -#RSTOPTS=--output-encoding=latin1 --stylesheet=$(STYLESHEET) -RSTOPTS=--output-encoding=latin1 +RSTOPTS=--output-encoding=latin1 --stylesheet=$(STYLESHEET) +#RSTOPTS=--output-encoding=latin1 %.html: $(srcdir)/%.txt $(RST2HTML) $(RSTOPTS) $< $@ + +userdoc: + (cd salome && $(MAKE) $(AM_MAKEFLAGS) userdoc) \ No newline at end of file diff --git a/doc/Makefile.in b/doc/Makefile.in deleted file mode 100644 index bfb404216..000000000 --- a/doc/Makefile.in +++ /dev/null @@ -1,534 +0,0 @@ -# Makefile.in generated by automake 1.9.5 from Makefile.am. -# @configure_input@ - -# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, -# 2003, 2004, 2005 Free Software Foundation, Inc. -# This Makefile.in is free software; the Free Software Foundation -# gives unlimited permission to copy and/or distribute it, -# with or without modifications, as long as this notice is preserved. - -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY, to the extent permitted by law; without -# even the implied warranty of MERCHANTABILITY or FITNESS FOR A -# PARTICULAR PURPOSE. - -@SET_MAKE@ - -# -* Makefile *- -# -# Author : Paul RASCLE (EDF) -# Date : 06/02/2006 -# $Header$ -# - -#SUBDIRS = salome - -srcdir = @srcdir@ -top_srcdir = @top_srcdir@ -VPATH = @srcdir@ -pkgdatadir = $(datadir)/@PACKAGE@ -pkglibdir = $(libdir)/@PACKAGE@ -pkgincludedir = $(includedir)/@PACKAGE@ -top_builddir = .. -am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd -INSTALL = @INSTALL@ -install_sh_DATA = $(install_sh) -c -m 644 -install_sh_PROGRAM = $(install_sh) -c -install_sh_SCRIPT = $(install_sh) -c -INSTALL_HEADER = $(INSTALL_DATA) -transform = $(program_transform_name) -NORMAL_INSTALL = : -PRE_INSTALL = : -POST_INSTALL = : -NORMAL_UNINSTALL = : -PRE_UNINSTALL = : -POST_UNINSTALL = : -build_triplet = @build@ -host_triplet = @host@ -target_triplet = @target@ -subdir = ./doc -DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in -ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 -am__aclocal_m4_deps = $(top_srcdir)/salome_adm/unix/config_files/ac_cxx_depend_flag.m4 \ - $(top_srcdir)/salome_adm/unix/config_files/ac_cxx_have_sstream.m4 \ - $(top_srcdir)/salome_adm/unix/config_files/ac_cxx_namespaces.m4 \ - $(top_srcdir)/salome_adm/unix/config_files/ac_cxx_option.m4 \ - $(top_srcdir)/salome_adm/unix/config_files/ac_cxx_template_options.m4 \ - $(top_srcdir)/salome_adm/unix/config_files/ac_cxx_use_std_iostream.m4 \ - $(top_srcdir)/salome_adm/unix/config_files/ac_cxx_warnings.m4 \ - $(top_srcdir)/salome_adm/unix/config_files/ac_linker_options.m4 \ - $(top_srcdir)/salome_adm/unix/config_files/acx_pthread.m4 \ - $(top_srcdir)/salome_adm/unix/config_files/check_boost.m4 \ - $(top_srcdir)/salome_adm/unix/config_files/check_cas.m4 \ - $(top_srcdir)/salome_adm/unix/config_files/check_corba.m4 \ - $(top_srcdir)/salome_adm/unix/config_files/check_cppunit.m4 \ - $(top_srcdir)/salome_adm/unix/config_files/check_hdf5.m4 \ - $(top_srcdir)/salome_adm/unix/config_files/check_htmlgen.m4 \ - $(top_srcdir)/salome_adm/unix/config_files/check_lam.m4 \ - $(top_srcdir)/salome_adm/unix/config_files/check_local.m4 \ - $(top_srcdir)/salome_adm/unix/config_files/check_lsf.m4 \ - $(top_srcdir)/salome_adm/unix/config_files/check_mpi.m4 \ - $(top_srcdir)/salome_adm/unix/config_files/check_mpich.m4 \ - $(top_srcdir)/salome_adm/unix/config_files/check_omniorb.m4 \ - $(top_srcdir)/salome_adm/unix/config_files/check_opengl.m4 \ - $(top_srcdir)/salome_adm/unix/config_files/check_openpbs.m4 \ - $(top_srcdir)/salome_adm/unix/config_files/check_qt.m4 \ - $(top_srcdir)/salome_adm/unix/config_files/check_sockets.m4 \ - $(top_srcdir)/salome_adm/unix/config_files/check_swig.m4 \ - $(top_srcdir)/salome_adm/unix/config_files/enable_pthreads.m4 \ - $(top_srcdir)/salome_adm/unix/config_files/production.m4 \ - $(top_srcdir)/salome_adm/unix/config_files/python.m4 \ - $(top_srcdir)/configure.ac -am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ - $(ACLOCAL_M4) -mkinstalldirs = $(install_sh) -d -CONFIG_CLEAN_FILES = -SOURCES = -DIST_SOURCES = -am__vpath_adj_setup = srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; -am__vpath_adj = case $$p in \ - $(srcdir)/*) f=`echo "$$p" | sed "s|^$$srcdirstrip/||"`;; \ - *) f=$$p;; \ - esac; -am__strip_dir = `echo $$p | sed -e 's|^.*/||'`; -am__installdirs = "$(DESTDIR)$(docdir)" -docDATA_INSTALL = $(INSTALL_DATA) -DATA = $(doc_DATA) -DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) -ACLOCAL = @ACLOCAL@ -AMDEP_FALSE = @AMDEP_FALSE@ -AMDEP_TRUE = @AMDEP_TRUE@ -AMTAR = @AMTAR@ -AR = @AR@ -AUTOCONF = @AUTOCONF@ -AUTOHEADER = @AUTOHEADER@ -AUTOMAKE = @AUTOMAKE@ -AWK = @AWK@ -BOOST_CPPFLAGS = @BOOST_CPPFLAGS@ -CAS_CPPFLAGS = @CAS_CPPFLAGS@ -CAS_CXXFLAGS = @CAS_CXXFLAGS@ -CAS_DATAEXCHANGE = @CAS_DATAEXCHANGE@ -CAS_KERNEL = @CAS_KERNEL@ -CAS_LDFLAGS = @CAS_LDFLAGS@ -CAS_LDPATH = @CAS_LDPATH@ -CAS_MATH = @CAS_MATH@ -CAS_MODELER = @CAS_MODELER@ -CAS_OCAF = @CAS_OCAF@ -CAS_OCAFVIS = @CAS_OCAFVIS@ -CAS_STDPLUGIN = @CAS_STDPLUGIN@ -CAS_TKTopAlgo = @CAS_TKTopAlgo@ -CAS_VIEWER = @CAS_VIEWER@ -CC = @CC@ -CCDEPMODE = @CCDEPMODE@ -CFLAGS = @CFLAGS@ -CORBA_CXXFLAGS = @CORBA_CXXFLAGS@ -CORBA_GEN_FALSE = @CORBA_GEN_FALSE@ -CORBA_GEN_TRUE = @CORBA_GEN_TRUE@ -CORBA_INCLUDES = @CORBA_INCLUDES@ -CORBA_LIBS = @CORBA_LIBS@ -CORBA_ROOT = @CORBA_ROOT@ -CP = @CP@ -CPP = @CPP@ -CPPFLAGS = @CPPFLAGS@ -CPPUNIT_INCLUDES = @CPPUNIT_INCLUDES@ -CPPUNIT_IS_OK_FALSE = @CPPUNIT_IS_OK_FALSE@ -CPPUNIT_IS_OK_TRUE = @CPPUNIT_IS_OK_TRUE@ -CPPUNIT_LIBS = @CPPUNIT_LIBS@ -CXX = @CXX@ -CXXCPP = @CXXCPP@ -CXXDEPMODE = @CXXDEPMODE@ -CXXFLAGS = @CXXFLAGS@ -CXXTMPDPTHFLAGS = @CXXTMPDPTHFLAGS@ -CXX_DEPEND_FLAG = @CXX_DEPEND_FLAG@ -CYGPATH_W = @CYGPATH_W@ -C_DEPEND_FLAG = @C_DEPEND_FLAG@ -DEFS = @DEFS@ -DEPCC = @DEPCC@ -DEPCXX = @DEPCXX@ -DEPCXXFLAGS = @DEPCXXFLAGS@ -DEPDIR = @DEPDIR@ -DOT = @DOT@ -DOXYGEN = @DOXYGEN@ -DVIPS = @DVIPS@ -ECHO = @ECHO@ -ECHO_C = @ECHO_C@ -ECHO_N = @ECHO_N@ -ECHO_T = @ECHO_T@ -EGREP = @EGREP@ -EXEEXT = @EXEEXT@ -F77 = @F77@ -FFLAGS = @FFLAGS@ -HAVE_SSTREAM = @HAVE_SSTREAM@ -HDF5_INCLUDES = @HDF5_INCLUDES@ -HDF5_LIBS = @HDF5_LIBS@ -HDF5_MT_LIBS = @HDF5_MT_LIBS@ -IDL = @IDL@ -IDLCXXFLAGS = @IDLCXXFLAGS@ -IDLPYFLAGS = @IDLPYFLAGS@ -IDL_CLN_CXX = @IDL_CLN_CXX@ -IDL_CLN_H = @IDL_CLN_H@ -IDL_CLN_OBJ = @IDL_CLN_OBJ@ -IDL_SRV_CXX = @IDL_SRV_CXX@ -IDL_SRV_H = @IDL_SRV_H@ -IDL_SRV_OBJ = @IDL_SRV_OBJ@ -INSTALL_DATA = @INSTALL_DATA@ -INSTALL_PROGRAM = @INSTALL_PROGRAM@ -INSTALL_SCRIPT = @INSTALL_SCRIPT@ -INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ -LATEX = @LATEX@ -LDEXPDYNFLAGS = @LDEXPDYNFLAGS@ -LDFLAGS = @LDFLAGS@ -LIBOBJS = @LIBOBJS@ -LIBS = @LIBS@ -LIBTOOL = @LIBTOOL@ -LN_S = @LN_S@ -LSF_INCLUDES = @LSF_INCLUDES@ -LSF_LDFLAGS = @LSF_LDFLAGS@ -LSF_LIBS = @LSF_LIBS@ -LTLIBOBJS = @LTLIBOBJS@ -MACHINE = @MACHINE@ -MAKEINFO = @MAKEINFO@ -MOC = @MOC@ -MPI_INCLUDES = @MPI_INCLUDES@ -MPI_IS_OK_FALSE = @MPI_IS_OK_FALSE@ -MPI_IS_OK_TRUE = @MPI_IS_OK_TRUE@ -MPI_LIBS = @MPI_LIBS@ -OBJEXT = @OBJEXT@ -OGL_INCLUDES = @OGL_INCLUDES@ -OGL_LIBS = @OGL_LIBS@ -OMNIORB_CXXFLAGS = @OMNIORB_CXXFLAGS@ -OMNIORB_IDL = @OMNIORB_IDL@ -OMNIORB_IDLCXXFLAGS = @OMNIORB_IDLCXXFLAGS@ -OMNIORB_IDLPYFLAGS = @OMNIORB_IDLPYFLAGS@ -OMNIORB_IDL_CLN_CXX = @OMNIORB_IDL_CLN_CXX@ -OMNIORB_IDL_CLN_H = @OMNIORB_IDL_CLN_H@ -OMNIORB_IDL_CLN_OBJ = @OMNIORB_IDL_CLN_OBJ@ -OMNIORB_IDL_SRV_CXX = @OMNIORB_IDL_SRV_CXX@ -OMNIORB_IDL_SRV_H = @OMNIORB_IDL_SRV_H@ -OMNIORB_IDL_SRV_OBJ = @OMNIORB_IDL_SRV_OBJ@ -OMNIORB_IDL_TIE_CXX = @OMNIORB_IDL_TIE_CXX@ -OMNIORB_IDL_TIE_H = @OMNIORB_IDL_TIE_H@ -OMNIORB_INCLUDES = @OMNIORB_INCLUDES@ -OMNIORB_LIBS = @OMNIORB_LIBS@ -OMNIORB_ROOT = @OMNIORB_ROOT@ -OPENPBS = @OPENPBS@ -OPENPBS_INCLUDES = @OPENPBS_INCLUDES@ -OPENPBS_LIBDIR = @OPENPBS_LIBDIR@ -OPENPBS_LIBS = @OPENPBS_LIBS@ -PACKAGE = @PACKAGE@ -PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ -PACKAGE_NAME = @PACKAGE_NAME@ -PACKAGE_STRING = @PACKAGE_STRING@ -PACKAGE_TARNAME = @PACKAGE_TARNAME@ -PACKAGE_VERSION = @PACKAGE_VERSION@ -PATH_SEPARATOR = @PATH_SEPARATOR@ -PDFLATEX = @PDFLATEX@ -PTHREAD_CC = @PTHREAD_CC@ -PTHREAD_CFLAGS = @PTHREAD_CFLAGS@ -PTHREAD_LIBS = @PTHREAD_LIBS@ -PYTHON = @PYTHON@ -PYTHONHOME = @PYTHONHOME@ -PYTHON_EXEC_PREFIX = @PYTHON_EXEC_PREFIX@ -PYTHON_INCLUDES = @PYTHON_INCLUDES@ -PYTHON_LIBS = @PYTHON_LIBS@ -PYTHON_PLATFORM = @PYTHON_PLATFORM@ -PYTHON_PREFIX = @PYTHON_PREFIX@ -PYTHON_SITE = @PYTHON_SITE@ -PYTHON_SITE_EXEC = @PYTHON_SITE_EXEC@ -PYTHON_SITE_INSTALL = @PYTHON_SITE_INSTALL@ -PYTHON_SITE_PACKAGE = @PYTHON_SITE_PACKAGE@ -PYTHON_VERSION = @PYTHON_VERSION@ -QTDIR = @QTDIR@ -QT_INCLUDES = @QT_INCLUDES@ -QT_LIBS = @QT_LIBS@ -QT_MT_INCLUDES = @QT_MT_INCLUDES@ -QT_MT_LIBS = @QT_MT_LIBS@ -QT_ROOT = @QT_ROOT@ -QT_VERS = @QT_VERS@ -RANLIB = @RANLIB@ -RCP = @RCP@ -RM = @RM@ -ROOT_BUILDDIR = @ROOT_BUILDDIR@ -ROOT_SRCDIR = @ROOT_SRCDIR@ -RSH = @RSH@ -RST2HTML = @RST2HTML@ -SCP = @SCP@ -SETX = @SETX@ -SET_MAKE = @SET_MAKE@ -SH = @SH@ -SHELL = @SHELL@ -SOCKETFLAGS = @SOCKETFLAGS@ -SOCKETLIBS = @SOCKETLIBS@ -SSH = @SSH@ -STDLIB = @STDLIB@ -STRIP = @STRIP@ -SWIG = @SWIG@ -SWIG_FLAGS = @SWIG_FLAGS@ -UIC = @UIC@ -VERSION = @VERSION@ -WITHMPI = @WITHMPI@ -WITHOPENPBS = @WITHOPENPBS@ -WITH_BATCH = @WITH_BATCH@ -WITH_BATCH_FALSE = @WITH_BATCH_FALSE@ -WITH_BATCH_TRUE = @WITH_BATCH_TRUE@ -WITH_LOCAL = @WITH_LOCAL@ -WITH_LOCAL_FALSE = @WITH_LOCAL_FALSE@ -WITH_LOCAL_TRUE = @WITH_LOCAL_TRUE@ -WITH_LSF = @WITH_LSF@ -WITH_LSF_FALSE = @WITH_LSF_FALSE@ -WITH_LSF_TRUE = @WITH_LSF_TRUE@ -WITH_OPENPBS_FALSE = @WITH_OPENPBS_FALSE@ -WITH_OPENPBS_TRUE = @WITH_OPENPBS_TRUE@ -ac_ct_AR = @ac_ct_AR@ -ac_ct_CC = @ac_ct_CC@ -ac_ct_CXX = @ac_ct_CXX@ -ac_ct_F77 = @ac_ct_F77@ -ac_ct_RANLIB = @ac_ct_RANLIB@ -ac_ct_STRIP = @ac_ct_STRIP@ -acx_pthread_config = @acx_pthread_config@ -am__fastdepCC_FALSE = @am__fastdepCC_FALSE@ -am__fastdepCC_TRUE = @am__fastdepCC_TRUE@ -am__fastdepCXX_FALSE = @am__fastdepCXX_FALSE@ -am__fastdepCXX_TRUE = @am__fastdepCXX_TRUE@ -am__include = @am__include@ -am__leading_dot = @am__leading_dot@ -am__quote = @am__quote@ -am__tar = @am__tar@ -am__untar = @am__untar@ -bindir = @bindir@ -build = @build@ -build_alias = @build_alias@ -build_cpu = @build_cpu@ -build_os = @build_os@ -build_vendor = @build_vendor@ -cppunit_ok = @cppunit_ok@ -datadir = @datadir@ -exec_prefix = @exec_prefix@ -host = @host@ -host_alias = @host_alias@ -host_cpu = @host_cpu@ -host_os = @host_os@ -host_vendor = @host_vendor@ -includedir = @includedir@ -infodir = @infodir@ -install_sh = @install_sh@ -libdir = @libdir@ -libexecdir = @libexecdir@ -localstatedir = @localstatedir@ -mandir = @mandir@ -mkdir_p = @mkdir_p@ -mpi_ok = @mpi_ok@ -oldincludedir = @oldincludedir@ -pkgpyexecdir = @pkgpyexecdir@ -pkgpythondir = @pkgpythondir@ -prefix = @prefix@ -program_transform_name = @program_transform_name@ -pyexecdir = @pyexecdir@ -pythondir = @pythondir@ -sbindir = @sbindir@ -sharedstatedir = @sharedstatedir@ -sysconfdir = @sysconfdir@ -target = @target@ -target_alias = @target_alias@ -target_cpu = @target_cpu@ -target_os = @target_os@ -target_vendor = @target_vendor@ -docdir = $(datadir)/doc -doc_DATA = \ - index.html \ - UnitTests.html \ - SALOME_Application.html \ - INSTALL.html - -EXTRA_DIST = $(doc_DATA) - -# Building html from restructured text files -STYLESHEET = rst.css -#RSTOPTS=--output-encoding=latin1 --stylesheet=$(STYLESHEET) -RSTOPTS = --output-encoding=latin1 -all: all-am - -.SUFFIXES: -$(srcdir)/Makefile.in: $(srcdir)/Makefile.am $(am__configure_deps) - @for dep in $?; do \ - case '$(am__configure_deps)' in \ - *$$dep*) \ - cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh \ - && exit 0; \ - exit 1;; \ - esac; \ - done; \ - echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnu ./doc/Makefile'; \ - cd $(top_srcdir) && \ - $(AUTOMAKE) --gnu ./doc/Makefile -.PRECIOUS: Makefile -Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status - @case '$?' in \ - *config.status*) \ - cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ - *) \ - echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \ - cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \ - esac; - -$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) - cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh - -$(top_srcdir)/configure: $(am__configure_deps) - cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh -$(ACLOCAL_M4): $(am__aclocal_m4_deps) - cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh - -mostlyclean-libtool: - -rm -f *.lo - -clean-libtool: - -rm -rf .libs _libs - -distclean-libtool: - -rm -f libtool -uninstall-info-am: -install-docDATA: $(doc_DATA) - @$(NORMAL_INSTALL) - test -z "$(docdir)" || $(mkdir_p) "$(DESTDIR)$(docdir)" - @list='$(doc_DATA)'; for p in $$list; do \ - if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \ - f=$(am__strip_dir) \ - echo " $(docDATA_INSTALL) '$$d$$p' '$(DESTDIR)$(docdir)/$$f'"; \ - $(docDATA_INSTALL) "$$d$$p" "$(DESTDIR)$(docdir)/$$f"; \ - done - -uninstall-docDATA: - @$(NORMAL_UNINSTALL) - @list='$(doc_DATA)'; for p in $$list; do \ - f=$(am__strip_dir) \ - echo " rm -f '$(DESTDIR)$(docdir)/$$f'"; \ - rm -f "$(DESTDIR)$(docdir)/$$f"; \ - done -tags: TAGS -TAGS: - -ctags: CTAGS -CTAGS: - - -distdir: $(DISTFILES) - @srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; \ - topsrcdirstrip=`echo "$(top_srcdir)" | sed 's|.|.|g'`; \ - list='$(DISTFILES)'; for file in $$list; do \ - case $$file in \ - $(srcdir)/*) file=`echo "$$file" | sed "s|^$$srcdirstrip/||"`;; \ - $(top_srcdir)/*) file=`echo "$$file" | sed "s|^$$topsrcdirstrip/|$(top_builddir)/|"`;; \ - esac; \ - if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ - dir=`echo "$$file" | sed -e 's,/[^/]*$$,,'`; \ - if test "$$dir" != "$$file" && test "$$dir" != "."; then \ - dir="/$$dir"; \ - $(mkdir_p) "$(distdir)$$dir"; \ - else \ - dir=''; \ - fi; \ - if test -d $$d/$$file; then \ - if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ - cp -pR $(srcdir)/$$file $(distdir)$$dir || exit 1; \ - fi; \ - cp -pR $$d/$$file $(distdir)$$dir || exit 1; \ - else \ - test -f $(distdir)/$$file \ - || cp -p $$d/$$file $(distdir)/$$file \ - || exit 1; \ - fi; \ - done -check-am: all-am -check: check-am -all-am: Makefile $(DATA) -installdirs: - for dir in "$(DESTDIR)$(docdir)"; do \ - test -z "$$dir" || $(mkdir_p) "$$dir"; \ - done -install: install-am -install-exec: install-exec-am -install-data: install-data-am -uninstall: uninstall-am - -install-am: all-am - @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am - -installcheck: installcheck-am -install-strip: - $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ - install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ - `test -z '$(STRIP)' || \ - echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install -mostlyclean-generic: - -clean-generic: - -distclean-generic: - -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) - -maintainer-clean-generic: - @echo "This command is intended for maintainers to use" - @echo "it deletes files that may require special tools to rebuild." -clean: clean-am - -clean-am: clean-generic clean-libtool mostlyclean-am - -distclean: distclean-am - -rm -f Makefile -distclean-am: clean-am distclean-generic distclean-libtool - -dvi: dvi-am - -dvi-am: - -html: html-am - -info: info-am - -info-am: - -install-data-am: install-docDATA - -install-exec-am: - -install-info: install-info-am - -install-man: - -installcheck-am: - -maintainer-clean: maintainer-clean-am - -rm -f Makefile -maintainer-clean-am: distclean-am maintainer-clean-generic - -mostlyclean: mostlyclean-am - -mostlyclean-am: mostlyclean-generic mostlyclean-libtool - -pdf: pdf-am - -pdf-am: - -ps: ps-am - -ps-am: - -uninstall-am: uninstall-docDATA uninstall-info-am - -.PHONY: all all-am check check-am clean clean-generic clean-libtool \ - distclean distclean-generic distclean-libtool distdir dvi \ - dvi-am html html-am info info-am install install-am \ - install-data install-data-am install-docDATA install-exec \ - install-exec-am install-info install-info-am install-man \ - install-strip installcheck installcheck-am installdirs \ - maintainer-clean maintainer-clean-generic mostlyclean \ - mostlyclean-generic mostlyclean-libtool pdf pdf-am ps ps-am \ - uninstall uninstall-am uninstall-docDATA uninstall-info-am - - -%.html: $(srcdir)/%.txt - $(RST2HTML) $(RSTOPTS) $< $@ -# Tell versions [3.59,3.63) of GNU make to not export all variables. -# Otherwise a system limit (for SysV at least) may be exceeded. -.NOEXPORT: diff --git a/doc/SALOME_Application.txt b/doc/SALOME_Application.txt index 590bf2c8f..df62c8486 100644 --- a/doc/SALOME_Application.txt +++ b/doc/SALOME_Application.txt @@ -16,23 +16,12 @@ This document corresponds to SALOME2 3.1. (alpha version) The following explains how to configure your own application with your list of modules, how to define and run this application on one or more computers. -Summary -------- +.. contents:: +.. sectnum:: -`1. General principles`_ -`2. Application Directory`_ - -`2.1 Proposal for env.d scripts`_ - -`2.2 User run scripts`_ - -`2.3 SALOME internal run script`_ - -`2.4 Other configuration files`_ - -1. General principles ---------------------- +General principles +------------------ A SALOME application is defined by a set of modules (GEOM, SMESH, ASTER...). @@ -63,8 +52,8 @@ account@computer is via rsh or ssh and must be configured for use without password (key exchange for ssh). Account may be different on each computer. -2. Application Directory ------------------------- +Application Directory +--------------------- The script createAppli.sh in ${KERNEL_ROOT_DIR}/bin/salome creates an application directory with the given path in parameter. ${APPLI} is a path @@ -94,8 +83,8 @@ alphanumeric order (after edition, think to remove backup files). the envd script is used by run scripts. -2.1 Proposal for env.d scripts -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Proposal for env.d scripts +~~~~~~~~~~~~~~~~~~~~~~~~~~ Each user **must define** his own configuration for these scripts, following the above rules. **The following is only an example not working as it is**. @@ -117,8 +106,8 @@ envSALOME.sh Note that ${APPLI} is already defined by the calling scripts when env.d/envSalome.sh is sourced. -2.2 User run scripts -~~~~~~~~~~~~~~~~~~~~ +User run scripts +~~~~~~~~~~~~~~~~ The SALOME user can use 4 scripts: @@ -143,8 +132,8 @@ runTests and port number), runTests defines a new configuration for naming service (new port number). -2.3 SALOME internal run scripts -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +SALOME internal run scripts +~~~~~~~~~~~~~~~~~~~~~~~~~~~ envd Sets SALOME application environment, envd is sourced by other scripts. @@ -156,8 +145,8 @@ runRemote.sh define the hostname and port userd for naming service, the remaining arguments define the command to execute. -2.4 Other configuration files -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Other configuration files +~~~~~~~~~~~~~~~~~~~~~~~~~ SalomeApp.xml This file is similar to the default given diff --git a/doc/salome/DevelopersGuide/Makefile.am b/doc/salome/DevelopersGuide/Makefile.am new file mode 100644 index 000000000..05493e641 --- /dev/null +++ b/doc/salome/DevelopersGuide/Makefile.am @@ -0,0 +1,33 @@ +# -* Makefile *- +# +# Author : Paul RASCLE (EDF) +# Date : 16/02/2006 +# $Header$ +# + +include $(top_srcdir)/salome_adm/unix/make_common_starter.am + +TEX=DevelopersGuide.tex +TEX_PS=$(TEX:%.tex=%.ps) +TEX_PDF=$(TEX:%.tex=%.pdf) + +#userdoc: $(TEX_PS) $(TEX_PDF) +userdoc: + @echo document tex a revoir + +clean: + \rm -f *~ *.bak *.aux *.log *.dvi *.toc $(TEX:%.tex=%.out) + \rm -f dummy thumb* + + +SUFFIXES = .tex .dvi .ps .pdf + +#implicits rules +.tex.dvi: clean + $(LATEX) $< + +.dvi.ps: + $(DVIPS) $< -o $@ + +.tex.pdf: clean + $(PDFLATEX) $< diff --git a/doc/salome/DevelopersGuide/Makefile.in b/doc/salome/DevelopersGuide/Makefile.in deleted file mode 100644 index be472d9a6..000000000 --- a/doc/salome/DevelopersGuide/Makefile.in +++ /dev/null @@ -1,62 +0,0 @@ -# Copyright (C) 2003 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, -# CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS -# -# 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. -# -# 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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org -# -# -# -# File : Makefile.in -# Author : Patrick GOLDBRONN (CEA) -# Module : doc -# $Header$ - -top_srcdir=@top_srcdir@ -top_builddir=../../.. -srcdir=@srcdir@ -VPATH=.:@srcdir@ - - -TEX=DevelopersGuide.tex -TEX_PS=$(TEX:%.tex=%.ps) -TEX_PDF=$(TEX:%.tex=%.pdf) - -.SUFFIXES: .tex .dvi .ps .pdf - -docs: $(TEX_PS) clean $(TEX_PDF) clean - -clean: - \rm -f *~ *.bak *.aux *.log *.dvi *.toc $(TEX:%.tex=%.out) - \rm -f dummy thumb* - -distclean: clean - \rm -f $(TEX_PS) $(TEX_PDF) - -install: - -#implicits rules -.tex.dvi: clean - @[ "x@LATEX@" != "x" ] && [ latex $< ] || \ - echo "Can'not execute .tex.dvi rule" - -.dvi.ps: - @[ "x@DVIPS@" != "x" ] && [ dvips $< -o $@ ] || \ - echo "Can'not execute .dvi.ps rule" - -.tex.pdf: clean - @[ "x@PDFLATEX@" != "x" ] && [ pdflatex $< ] || \ - echo "Can'not execute .tex.pdf rule" - diff --git a/doc/salome/Makefile.am b/doc/salome/Makefile.am new file mode 100644 index 000000000..f718bbc07 --- /dev/null +++ b/doc/salome/Makefile.am @@ -0,0 +1,20 @@ +# -* Makefile *- +# +# Author : Paul RASCLE (EDF) +# Date : 16/02/2006 +# $Header$ +# + +include $(top_srcdir)/salome_adm/unix/make_common_starter.am + +SUBDIRS= tui DevelopersGuide gui + +index_html: + $(INSTALL) -d $(docdir); + cp -f $(srcdir)/KERNEL_index.html $(docdir) + +userdoc: index_html + list='$(SUBDIRS)'; for subdir in $$list; do \ + echo "Making userdoc in $$subdir"; \ + (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) userdoc) \ + done; diff --git a/doc/salome/Makefile.in b/doc/salome/Makefile.in deleted file mode 100644 index a57414a82..000000000 --- a/doc/salome/Makefile.in +++ /dev/null @@ -1,44 +0,0 @@ - -# -* Makefile *- -# -# Author : Patrick GOLDBRONN (CEA) -# Date : 30/11/2001 -# $Header$ -# -# source path -top_srcdir=@top_srcdir@ -top_builddir=../.. -srcdir=@srcdir@ -VPATH=.:@srcdir@ - -SUBDIRS= tui DevelopersGuide gui - -@COMMENCE@ - -docs: - @@SETX@; for d in $(SUBDIRS); do \ - (cd $$d && $(MAKE) $@) || exit 1; \ - done; \ - cp -f $(srcdir)/KERNEL_index.html KERNEL_index.html - -clean: - @@SETX@; for d in $(SUBDIRS); do \ - (cd $$d && $(MAKE) $@) || exit 1; \ - done - -distclean: clean - @@SETX@; for d in $(SUBDIRS); do \ - (cd $$d && $(MAKE) $@) || exit 1; \ - done - -install: - $(MAKE) docs - (cd tui && $(MAKE) install); - (cd gui && $(MAKE) install); - cp -f KERNEL_index.html $(docdir) - -uninstall: - @@SETX@; for d in $(SUBDIRS); do \ - (cd $$d && $(MAKE) $@) || exit 1; \ - done; \ - rm -fr $(docdir)/KERNEL_index.html diff --git a/doc/salome/gui/Makefile.am b/doc/salome/gui/Makefile.am new file mode 100644 index 000000000..a4272f3a9 --- /dev/null +++ b/doc/salome/gui/Makefile.am @@ -0,0 +1,13 @@ +# -* Makefile *- +# +# Author : Paul RASCLE (EDF) +# Date : 16/02/2006 +# $Header$ +# + +include $(top_srcdir)/salome_adm/unix/make_common_starter.am + +userdoc: + $(INSTALL) -d $(docdir)/gui; + cp -fr $(srcdir)/KERNEL $(docdir)/gui; + rm -rf `find $(docdir)/gui -name CVS` diff --git a/doc/salome/gui/Makefile.in b/doc/salome/gui/Makefile.in deleted file mode 100644 index ec67d8086..000000000 --- a/doc/salome/gui/Makefile.in +++ /dev/null @@ -1,33 +0,0 @@ -# Copyright (C) 2003 CEA/DEN, EDF R&D -# -# -# -# File : Makefile.in -# Author : Vasily Rusyaev (Open Cascade NN) -# Module : doc -# $Header: - -top_srcdir=@top_srcdir@ -top_builddir=../../.. -srcdir=@srcdir@ -VPATH=.:@srcdir@ - -@COMMENCE@ - -docs: - cp -fr $(srcdir)/KERNEL ./ - -find $(PWD) -name CVS -exec rm -rf {} \; - -clean: - rm -fr `ls | grep -v "Makefile"` - -distclean: clean - rm -fr KERNEL - -install: - mkdir -p $(docdir)/gui - cp -rf KERNEL $(docdir)/gui - -find $(PWD) -name CVS -exec rm -rf {} \; - -uninstall: - rm -rf $(docdir)/gui/KERNEL diff --git a/doc/salome/tui/Makefile.am b/doc/salome/tui/Makefile.am new file mode 100644 index 000000000..45d848baa --- /dev/null +++ b/doc/salome/tui/Makefile.am @@ -0,0 +1,22 @@ +# -* Makefile *- +# +# Author : Paul RASCLE (EDF) +# Date : 16/02/2006 +# $Header$ +# + +include $(top_srcdir)/salome_adm/unix/make_common_starter.am + +userdoc: + cp -fr $(srcdir)/KERNEL ./INPUT; \ + cd INPUT; \ + sed 's|../../../share/salome|@top_srcdir@|' ./doxyfile > ./doxyfile1; \ + mv -f doxyfile1 doxyfile; \ + $(DOXYGEN) ./doxyfile; \ + cd ..; + $(INSTALL) -d $(docdir)/tui/KERNEL; + cp -fr $(srcdir)/KERNEL/sources/static/*.* $(docdir)/tui/KERNEL; + cp -fr $(srcdir)/KERNEL/sources/ $(docdir)/tui/KERNEL; + cp -fr $(srcdir)/KERNEL/HTML/ $(docdir)/tui/KERNEL; + cp -f $(srcdir)/pythfilter.py $(docdir)/tui/KERNEL; + diff --git a/doc/salome/tui/Makefile.in b/doc/salome/tui/Makefile.in deleted file mode 100644 index eeaff820d..000000000 --- a/doc/salome/tui/Makefile.in +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright (C) 2003 CEA/DEN, EDF R&D -# -# -# -# File : Makefile.in -# Author : Vasily Rusyaev (Open Cascade NN) -# Module : doc -# $Header: - -top_srcdir=@top_srcdir@ -top_builddir=../../.. -root_srcdir=@ROOT_SRCDIR@ -srcdir=@srcdir@ -VPATH=.:@srcdir@ -doxygen=@DOXYGEN@ - -@COMMENCE@ - -docs: - cp -fr $(srcdir)/KERNEL ./INPUT; \ - cd INPUT; \ - sed 's|../../../share/salome|$(root_srcdir)|' ./doxyfile > ./doxyfile1; \ - mv -f doxyfile1 doxyfile; \ - $(doxygen) ./doxyfile; \ - cd ..; \ - mkdir KERNEL; \ - cp -fr $(srcdir)/KERNEL/sources/static/*.* ./KERNEL/ - cp -fr $(srcdir)/KERNEL/sources/ KERNEL/ - cp -fr $(srcdir)/KERNEL/HTML/ KERNEL/ - cp -f $(srcdir)/pythfilter.py KERNEL/ - rm -fr INPUT - -clean: - rm -fr KERNEL - -distclean: clean - rm -fr INPUT - -install: - $(INSTALL) -d $(docdir); \ - mkdir -p $(docdir)/tui - cp -fr KERNEL $(docdir)/tui - -uninstall: - rm -fr $(docdir)/tui/KERNEL diff --git a/salome_adm/unix/make_common_starter.am b/salome_adm/unix/make_common_starter.am index 727e07eea..c19d256e7 100644 --- a/salome_adm/unix/make_common_starter.am +++ b/salome_adm/unix/make_common_starter.am @@ -26,3 +26,5 @@ salomem4dir = $(salomeadmdir)/unix/config_files # Shared modules installation directory sharedpkgpythondir =$(pkgpythondir)/shared_modules +# Documentation directory +docdir = $(datadir)/doc/@PACKAGE@