doc/Makefile.am

   1 # Copyright (C) 2009-2013  CEA/DEN, 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
  20 include $(top_srcdir)/adm_local/unix/make_common_starter.am
  21
  22 # Makefile.am for Sphinx documentation of HEXABLOCK component
  23 # Author: Marine Marcilhac From CS
  24
  25 .PHONY : latex
  26
  27 if SPHINX_IS_OK
  28
  29 hexablockdoc_DATA=html/index.html
  30
  31 html/index.html:$(RSTFILES)
  32         make htm
  33
  34 endif
  35
  36 dev_docs: build_dev_docs install_dev_docs
  37
  38 build_dev_docs:
  39         doxygen
  40
  41 help:
  42         @echo "Please use \`make <target>' where <target> is one of"
  43         @echo "  html      to make standalone HTML files"
  44         @echo "  pickle    to make pickle files"
  45         @echo "  json      to make JSON files"
  46         @echo "  htmlhelp  to make HTML files and a HTML help project"
  47         @echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
  48         @echo "  changes   to make an overview over all changed/added/deprecated items"
  49         @echo "  linkcheck to check all external links for integrity"
  50
  51 DOXFILES=
  52
  53 EXTRA_DIST+= $(DOXFILES)
  54
  55 hexablockdocdir=$(docdir)/gui/HEXABLOCK
  56 hexablockdevdocdir=$(docdir)/gui/HEXABLOCK/dev
  57
  58 SPHINXOPTS      =
  59 SOURCEDIR       = $(srcdir)
  60 SPHINXBUILD     = sphinx-build
  61 PAPEROPT_a4     = -D latex_paper_size=a4
  62 ALLSPHINXOPTS   = -d doctrees $(PAPEROPT_a4) $(SPHINXOPTS) $(SOURCEDIR)
  63
  64 htm:
  65         mkdir -p html doctrees
  66         $(SPHINXBUILD) -c $(top_builddir)/doc -b html $(ALLSPHINXOPTS) html
  67         @echo
  68         @echo "Build finished. The HTML pages are in html."
  69
  70 latex:
  71         mkdir -p latex doctrees
  72         $(SPHINXBUILD) -c $(top_builddir)/doc -b latex $(ALLSPHINXOPTS) latex
  73         @echo
  74         @echo "Build finished; the LaTeX files are in latex."
  75         @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
  76               "run these through (pdf)latex."
  77
  78 pdf:
  79         $(SPHINXBUILD) -c $(top_builddir)/doc -b pdf $(ALLSPHINXOPTS) pdf
  80         @echo
  81         @echo "Build finished. The pdf documents are in pdf."
  82
  83 html:
  84                  mkdir -p $@
  85
  86 htmldev:
  87                  mkdir -p $@
  88
  89 RSTFILES= \
  90         annexe.rst                  \
  91         block_method.rst            \
  92         cad.rst                     \
  93         creategrids.rst             \
  94         full_example_bridle.rst     \
  95         general.rst                 \
  96         gui.rst                     \
  97         gui_asso_quad_to_geom.rst   \
  98         gui_asso_vertex_to_geom.rst \
  99         gui_blocks_for_cyl_pipe.rst \
 100         gui_component.rst           \
 101         gui_cut_hexa.rst            \
 102         gui_cyl.rst                 \
 103         gui_disc_elmts.rst          \
 104         gui_discret_law.rst         \
 105         gui_document.rst            \
 106         gui_edge.rst                \
 107         gui_elements.rst            \
 108         gui_groups.rst              \
 109         gui_hexahedron.rst          \
 110         gui_make_elmts.rst          \
 111         gui_make_symmetry.rst       \
 112         gui_merge_elmts.rst         \
 113         gui_mesh.rst                \
 114         gui_modify_elmts.rst        \
 115         gui_modify_symmetry.rst     \
 116         gui_association.rst         \
 117         gui_pipe.rst                \
 118         gui_prism_join_quad.rst     \
 119         gui_propag.rst              \
 120         gui_quadrangle.rst          \
 121         gui_quad_revolution.rst     \
 122         gui_remove.rst              \
 123         gui_replace_hexa.rst        \
 124         gui_hemisphere.rst          \
 125         gui_vector.rst              \
 126         gui_vertex.rst              \
 127         index.rst                   \
 128         interactive.rst             \
 129         intro_association.rst       \
 130         intro_groups.rst            \
 131         intro_mesh.rst              \
 132         intro_python.rst            \
 133         mesh.rst                    \
 134         python.rst                  \
 135         tui.rst                     \
 136         tui_asso_quad_to_geom.rst   \
 137         tui_asso_vertex_to_geom.rst \
 138         tui_blocks_for_cyl_pipe.rst \
 139         tui_cartgrid.rst            \
 140         tui_component.rst           \
 141         tui_cut_hexa.rst            \
 142         tui_make_symmetry.rst       \
 143         tui_perform_symmetry.rst    \
 144         tui_cylgrid.rst             \
 145         tui_cyl.rst                 \
 146         tui_disc_elmts.rst          \
 147         tui_quad_revolution.rst     \
 148         tui_discret_law.rst         \
 149         tui_association.rst         \
 150         tui_document.rst            \
 151         tui_edge.rst                \
 152         tui_elements.rst            \
 153         tui_groups.rst              \
 154         tui_hexahedron.rst          \
 155         tui_make_elmts.rst          \
 156         tui_hemisphere_rind.rst     \
 157         tui_merge_elmts.rst         \
 158         tui_mesh.rst                \
 159         tui_modify_elmts.rst        \
 160         tui_pipe.rst                \
 161         tui_prism_join_quad.rst     \
 162         tui_propag.rst              \
 163         tui_quadrangle.rst          \
 164         tui_remove.rst              \
 165         tui_replace_hexa.rst        \
 166         tui_sphergrid.rst           \
 167         tui_vector.rst              \
 168         tui_vertex.rst
 169
 170
 171
 172
 173
 174
 175
 176 EXTRA_DIST+= $(RSTFILES) _static cas_test_python
 177
 178 install-data-local:
 179         $(INSTALL) -d $(DESTDIR)$(hexablockdocdir)
 180         if test -d "html"; then b=; else b="$(srcdir)/"; fi; \
 181         cp -rf $$b"html"/* $(DESTDIR)$(hexablockdocdir) ; \
 182         if test -f $$b"latex"/using.pdf; then cp -f $$b"latex"/using.pdf $(DESTDIR)$(hexablockdocdir) ; fi; \
 183         if test -f $$b"latex"/integration.pdf; then cp -f $$b"latex"/integration.pdf $(DESTDIR)$(hexablockdocdir) ; fi;
 184
 185 install_dev_docs:
 186         $(INSTALL) -d $(DESTDIR)$(hexablockdevdocdir)
 187         if test -d "htmldev"; then b=; else b="$(srcdir)/"; fi; \
 188         find $$b"htmldev" -name "*.*" -exec cp -rf {} $(DESTDIR)$(hexablockdevdocdir) ';' ; \
 189         cp -rf $(top_srcdir)/src/hexablockloader/samples $(DESTDIR)$(hexablockdevdocdir); \
 190         rm -rf $(DESTDIR)$(hexablockdevdocdir)/samples/CVS;
 191
 192 uninstall-local:
 193         chmod -R +w $(DESTDIR)$(hexablockdocdir)
 194         rm -rf $(DESTDIR)$(hexablockdocdir)/*
 195
 196 clean-local:
 197         -rm -rf html latex doctrees
 198         if test -d "html"; then rm -rf html ; fi
 199
 200 dist-hook:
 201         if test -d "html"; then b=; else b="$(srcdir)/"; fi; \
 202         if test -d $$b"html"; then cp -rf $$b"html" $(distdir) ; fi; \
 203         if test -d "htmldev"; then b=; else b="$(srcdir)/"; fi; \
 204         if test -d $$b"htmldev"; then cp -rf $$b"htmldev" $(distdir) ; fi