1 include $(top_srcdir)/adm_local/make_common_starter.am
3 # You can set these variables from the command line.
5 SPHINXBUILD = sphinx-build
7 BUILDDIR = $(top_builddir)/doc/build
8 SRCDIR = $(top_srcdir)/doc
10 EXTRA_DIST = main.rst intro.rst conf.py
14 ${mkinstalldirs} $(DESTDIR)$(docdir)
15 ${mkinstalldirs} $(salomeresdir)
16 cp -R $(BUILDDIR)/html/* $(DESTDIR)$(docdir)
17 cp $(SRCDIR)/resources/*.png $(salomeresdir)
18 cp $(SRCDIR)/images/eficas_*.png $(salomeresdir)
21 chmod -R +w $(DESTDIR)$(docdir)
22 rm -rf $(DESTDIR)$(docdir)
23 rm $(salomeresdir)/*.png
26 -rm -rf $(top_builddir)/doc/build
30 PAPEROPT_a4 = -D latex_paper_size=a4
31 PAPEROPT_letter = -D latex_paper_size=letter
32 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(top_srcdir)/doc
34 .PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
37 @echo "Please use \`make <target>' where <target> is one of"
38 @echo " html to make standalone HTML files"
39 @echo " dirhtml to make HTML files named index.html in directories"
40 @echo " pickle to make pickle files"
41 @echo " json to make JSON files"
42 @echo " htmlhelp to make HTML files and a HTML help project"
43 @echo " qthelp to make HTML files and a qthelp project"
44 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
45 @echo " changes to make an overview of all changed/added/deprecated items"
46 @echo " linkcheck to check all external links for integrity"
47 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
53 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
55 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
58 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
60 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
63 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
65 @echo "Build finished; now you can process the pickle files."
68 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
70 @echo "Build finished; now you can process the JSON files."
73 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
75 @echo "Build finished; now you can run HTML Help Workshop with the" \
76 ".hhp project file in $(BUILDDIR)/htmlhelp."
79 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
81 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
82 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
83 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ADAO.qhcp"
84 @echo "To view the help file:"
85 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ADAO.qhc"
88 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
90 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
91 @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
92 "run these through (pdf)latex."
95 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
97 @echo "The overview file is in $(BUILDDIR)/changes."
100 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
102 @echo "Link check complete; look for any errors in the above output " \
103 "or in $(BUILDDIR)/linkcheck/output.txt."
106 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
107 @echo "Testing of doctests in the sources finished, look at the " \
108 "results in $(BUILDDIR)/doctest/output.txt."