1 # Copyright (C) 2008-2023 EDF R&D
3 # This file is part of SALOME ADAO module
5 # This library is free software; you can redistribute it and/or
6 # modify it under the terms of the GNU Lesser General Public
7 # License as published by the Free Software Foundation; either
8 # version 2.1 of the License.
10 # This library is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 # Lesser General Public License for more details.
15 # You should have received a copy of the GNU Lesser General Public
16 # License along with this library; if not, write to the Free Software
17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 # Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
23 include $(top_srcdir)/adm_local/make_common_starter.am
25 # You can set these variables from the command line.
28 SPHINXBUILD = sphinx-build
30 BUILDDIR = $(top_builddir)/doc/build/$(DOCLANG)
31 SRCDIR = $(top_srcdir)/doc/$(DOCLANG)
33 EXTRA_DIST = conf.py advanced.rst index.rst intro.rst theory.rst tutorials_in_salome.rst gui_in_salome.rst \
35 resources/ADAO_small.png \
36 resources/ADAO_small_rouge.png \
37 resources/ADAO_small_vert.png \
38 images/adao_activate.png \
39 images/adao_jdcexample01.png \
40 images/adao_scriptentry01.png \
41 images/adao_viewer.png \
42 images/eficas_new.png \
43 images/eficas_save.png \
44 images/eficas_yacs.png \
45 images/yacs_generatedscheme.png \
46 images/adao_exporttoyacs.png \
47 images/adao_jdcexample02.png \
48 images/adao_scriptentry02.png \
49 images/eficas_close.png \
50 images/eficas_open.png \
51 images/eficas_saveas.png \
52 images/eficas_tree.png \
53 images/eficas_valid.png \
54 images/yacs_containerlog.png
58 ${mkinstalldirs} $(DESTDIR)$(docdir)/$(DOCLANG)
59 ${mkinstalldirs} $(DESTDIR)$(salomeresdir)
60 cp -R $(BUILDDIR)/html/* $(DESTDIR)$(docdir)/$(DOCLANG)
61 cp $(SRCDIR)/resources/*.png $(DESTDIR)$(salomeresdir)
62 cp $(SRCDIR)/images/eficas_*.png $(DESTDIR)$(salomeresdir)
65 chmod -R +w $(DESTDIR)$(docdir)/$(DOCLANG)
66 rm -rf $(DESTDIR)$(docdir)
67 rm -f $(DESTDIR)$(salomeresdir)/*.png
74 PAPEROPT_a4 = -D latex_elements.papersize='a4paper'
75 PAPEROPT_letter = -D latex_elements.papersize='letterpaper'
76 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SRCDIR)
78 .PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
81 @echo "Please use \`make <target>' where <target> is one of"
82 @echo " html to make standalone HTML files"
83 @echo " dirhtml to make HTML files named index.html in directories"
84 @echo " pickle to make pickle files"
85 @echo " json to make JSON files"
86 @echo " htmlhelp to make HTML files and a HTML help project"
87 @echo " qthelp to make HTML files and a qthelp project"
88 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
89 @echo " changes to make an overview of all changed/added/deprecated items"
90 @echo " linkcheck to check all external links for integrity"
91 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
97 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
99 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
102 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
104 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
107 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
109 @echo "Build finished; now you can process the pickle files."
112 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
114 @echo "Build finished; now you can process the JSON files."
117 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
119 @echo "Build finished; now you can run HTML Help Workshop with the" \
120 ".hhp project file in $(BUILDDIR)/htmlhelp."
123 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
125 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
126 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
127 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ADAO.qhcp"
128 @echo "To view the help file:"
129 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ADAO.qhc"
132 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
134 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
135 @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
136 "run these through (pdf)latex."
139 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
141 @echo "The overview file is in $(BUILDDIR)/changes."
144 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
146 @echo "Link check complete; look for any errors in the above output " \
147 "or in $(BUILDDIR)/linkcheck/output.txt."
150 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
151 @echo "Testing of doctests in the sources finished, look at the " \
152 "results in $(BUILDDIR)/doctest/output.txt."