doc/en/Makefile.am

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