doc/fr/Makefile.am

   1 # Copyright (C) 2008-2015 EDF R&D
   2 #
   3 # This file is part of SALOME ADAO module
   4 #
   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.
   9 #
  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.
  14 #
  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
  18 #
  19 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  20 #
  21 # Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
  22
  23 include $(top_srcdir)/adm_local/make_common_starter.am
  24
  25 # You can set these variables from the command line.
  26 DOCLANG       = fr
  27 SPHINXOPTS    =
  28 SPHINXBUILD   = sphinx-build
  29 PAPER         =
  30 BUILDDIR      = $(top_builddir)/doc/build/$(DOCLANG)
  31 SRCDIR        = $(top_srcdir)/doc/$(DOCLANG)
  32
  33 EXTRA_DIST = conf.py advanced.rst  examples.rst  index.rst  intro.rst  theory.rst  using.rst \
  34              resources/ADAO.png \
  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/yacs_containerlog.png
  53
  54 install-data-local:
  55         make html
  56         ${mkinstalldirs} $(DESTDIR)$(docdir)/$(DOCLANG)
  57         ${mkinstalldirs} $(DESTDIR)$(salomeresdir)
  58         cp -R $(BUILDDIR)/html/* $(DESTDIR)$(docdir)/$(DOCLANG)
  59         cp $(SRCDIR)/resources/*.png $(DESTDIR)$(salomeresdir)
  60         cp $(SRCDIR)/images/eficas_*.png $(DESTDIR)$(salomeresdir)
  61
  62 uninstall-local:
  63         chmod -R +w $(DESTDIR)$(docdir)/$(DOCLANG)
  64         rm -rf $(DESTDIR)$(docdir)
  65         rm -f $(DESTDIR)$(salomeresdir)/*.png
  66
  67 clean-local:
  68         -rm -rf $(BUILDDIR)
  69
  70
  71 # Internal variables.
  72 PAPEROPT_a4     = -D latex_paper_size=a4
  73 PAPEROPT_letter = -D latex_paper_size=letter
  74 ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SRCDIR)
  75
  76 .PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
  77
  78 help:
  79         @echo "Please use \`make <target>' where <target> is one of"
  80         @echo "  html      to make standalone HTML files"
  81         @echo "  dirhtml   to make HTML files named index.html in directories"
  82         @echo "  pickle    to make pickle files"
  83         @echo "  json      to make JSON files"
  84         @echo "  htmlhelp  to make HTML files and a HTML help project"
  85         @echo "  qthelp    to make HTML files and a qthelp project"
  86         @echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
  87         @echo "  changes   to make an overview of all changed/added/deprecated items"
  88         @echo "  linkcheck to check all external links for integrity"
  89         @echo "  doctest   to run all doctests embedded in the documentation (if enabled)"
  90
  91 clean:
  92         -rm -rf $(BUILDDIR)/*
  93
  94 html:
  95         $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
  96         @echo
  97         @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
  98
  99 dirhtml:
 100         $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
 101         @echo
 102         @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
 103
 104 pickle:
 105         $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
 106         @echo
 107         @echo "Build finished; now you can process the pickle files."
 108
 109 json:
 110         $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
 111         @echo
 112         @echo "Build finished; now you can process the JSON files."
 113
 114 htmlhelp:
 115         $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
 116         @echo
 117         @echo "Build finished; now you can run HTML Help Workshop with the" \
 118               ".hhp project file in $(BUILDDIR)/htmlhelp."
 119
 120 qthelp:
 121         $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
 122         @echo
 123         @echo "Build finished; now you can run "qcollectiongenerator" with the" \
 124               ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
 125         @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ADAO.qhcp"
 126         @echo "To view the help file:"
 127         @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ADAO.qhc"
 128
 129 latex:
 130         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 131         @echo
 132         @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
 133         @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
 134               "run these through (pdf)latex."
 135
 136 changes:
 137         $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
 138         @echo
 139         @echo "The overview file is in $(BUILDDIR)/changes."
 140
 141 linkcheck:
 142         $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
 143         @echo
 144         @echo "Link check complete; look for any errors in the above output " \
 145               "or in $(BUILDDIR)/linkcheck/output.txt."
 146
 147 doctest:
 148         $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
 149         @echo "Testing of doctests in the sources finished, look at the " \
 150               "results in $(BUILDDIR)/doctest/output.txt."