doc/Makefile.am

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