doc/Makefile.am

   1 # Copyright (C) 2010-2011 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: André Ribes, andre.ribes@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 SPHINXOPTS    =
  25 SPHINXBUILD   = sphinx-build
  26 PAPER         =
  27 BUILDDIR      = $(top_builddir)/doc/build
  28 SRCDIR        = $(top_srcdir)/doc
  29
  30 EXTRA_DIST = conf.py advanced.rst  examples.rst  index.rst  intro.rst  theory.rst  using.rst \
  31              resources/ADAO.png \
  32              resources/ADAO_small.png \
  33              resources/ADAO_small_rouge.png \
  34              resources/ADAO_small_vert.png \
  35              images/adao_activate.png \
  36              images/adao_jdcexample01.png \
  37              images/adao_scriptentry01.png \
  38              images/adao_viewer.png \
  39              images/eficas_new.png \
  40              images/eficas_save.png \
  41              images/eficas_yacs.png \
  42              images/yacs_generatedscheme.png \
  43              images/adao_exporttoyacs.png \
  44              images/adao_jdcexample02.png \
  45              images/adao_scriptentry02.png \
  46              images/eficas_close.png \
  47              images/eficas_open.png \
  48              images/eficas_saveas.png \
  49              images/yacs_containerlog.png
  50
  51 install-data-local:
  52         make html
  53         ${mkinstalldirs} $(DESTDIR)$(docdir)
  54         ${mkinstalldirs} $(DESTDIR)$(salomeresdir)
  55         cp -R $(BUILDDIR)/html/* $(DESTDIR)$(docdir)
  56         cp $(SRCDIR)/resources/*.png $(DESTDIR)$(salomeresdir)
  57         cp $(SRCDIR)/images/eficas_*.png $(DESTDIR)$(salomeresdir)
  58
  59 uninstall-local:
  60         chmod -R +w $(DESTDIR)$(docdir)
  61         rm -rf $(DESTDIR)$(docdir)
  62         rm -f $(DESTDIR)$(salomeresdir)/*.png
  63
  64 clean-local:
  65         -rm -rf $(top_builddir)/doc/build
  66
  67
  68 # Internal variables.
  69 PAPEROPT_a4     = -D latex_paper_size=a4
  70 PAPEROPT_letter = -D latex_paper_size=letter
  71 ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(top_srcdir)/doc
  72
  73 .PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
  74
  75 help:
  76         @echo "Please use \`make <target>' where <target> is one of"
  77         @echo "  html      to make standalone HTML files"
  78         @echo "  dirhtml   to make HTML files named index.html in directories"
  79         @echo "  pickle    to make pickle files"
  80         @echo "  json      to make JSON files"
  81         @echo "  htmlhelp  to make HTML files and a HTML help project"
  82         @echo "  qthelp    to make HTML files and a qthelp project"
  83         @echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
  84         @echo "  changes   to make an overview of all changed/added/deprecated items"
  85         @echo "  linkcheck to check all external links for integrity"
  86         @echo "  doctest   to run all doctests embedded in the documentation (if enabled)"
  87
  88 clean:
  89         -rm -rf $(BUILDDIR)/*
  90
  91 html:
  92         $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
  93         @echo
  94         @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
  95
  96 dirhtml:
  97         $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
  98         @echo
  99         @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
 100
 101 pickle:
 102         $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
 103         @echo
 104         @echo "Build finished; now you can process the pickle files."
 105
 106 json:
 107         $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
 108         @echo
 109         @echo "Build finished; now you can process the JSON files."
 110
 111 htmlhelp:
 112         $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
 113         @echo
 114         @echo "Build finished; now you can run HTML Help Workshop with the" \
 115               ".hhp project file in $(BUILDDIR)/htmlhelp."
 116
 117 qthelp:
 118         $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
 119         @echo
 120         @echo "Build finished; now you can run "qcollectiongenerator" with the" \
 121               ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
 122         @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ADAO.qhcp"
 123         @echo "To view the help file:"
 124         @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ADAO.qhc"
 125
 126 latex:
 127         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 128         @echo
 129         @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
 130         @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
 131               "run these through (pdf)latex."
 132
 133 changes:
 134         $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
 135         @echo
 136         @echo "The overview file is in $(BUILDDIR)/changes."
 137
 138 linkcheck:
 139         $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
 140         @echo
 141         @echo "Link check complete; look for any errors in the above output " \
 142               "or in $(BUILDDIR)/linkcheck/output.txt."
 143
 144 doctest:
 145         $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
 146         @echo "Testing of doctests in the sources finished, look at the " \
 147               "results in $(BUILDDIR)/doctest/output.txt."