mirror of
https://git.salome-platform.org/gitpub/modules/smesh.git
synced 2024-12-28 18:30:35 +05:00
- added the doc of the Yams plugin in the SALOME install
- added an entry in the SMESH Plug-ins help menu
This commit is contained in:
parent
16ed45cd7d
commit
fe6504b34f
@ -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 \
|
||||
|
@ -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">
|
||||
|
@ -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
|
||||
|
61
src/Tools/YamsPlug/doc/Makefile.am
Normal file
61
src/Tools/YamsPlug/doc/Makefile.am
Normal file
@ -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."
|
||||
|
Loading…
Reference in New Issue
Block a user