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 = main.rst intro.rst conf.py
  11
  12 install-data-local:
  13         make html
  14         ${mkinstalldirs} $(DESTDIR)$(docdir)
  15         cp -R $(BUILDDIR)/html/* $(DESTDIR)$(docdir)
  16         cp $(SRCDIR)/resources/*.png $(salomeresdir)
  17
  18 uninstall-local:
  19         chmod -R +w $(DESTDIR)$(docdir)
  20         rm -rf $(DESTDIR)$(docdir)
  21         rm  $(salomeresdir)/*.png
  22
  23 clean-local:
  24         -rm -rf $(top_builddir)/doc/build
  25
  26
  27 # Internal variables.
  28 PAPEROPT_a4     = -D latex_paper_size=a4
  29 PAPEROPT_letter = -D latex_paper_size=letter
  30 ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(top_srcdir)/doc
  31
  32 .PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
  33
  34 help:
  35         @echo "Please use \`make <target>' where <target> is one of"
  36         @echo "  html      to make standalone HTML files"
  37         @echo "  dirhtml   to make HTML files named index.html in directories"
  38         @echo "  pickle    to make pickle files"
  39         @echo "  json      to make JSON files"
  40         @echo "  htmlhelp  to make HTML files and a HTML help project"
  41         @echo "  qthelp    to make HTML files and a qthelp project"
  42         @echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
  43         @echo "  changes   to make an overview of all changed/added/deprecated items"
  44         @echo "  linkcheck to check all external links for integrity"
  45         @echo "  doctest   to run all doctests embedded in the documentation (if enabled)"
  46
  47 clean:
  48         -rm -rf $(BUILDDIR)/*
  49
  50 html:
  51         $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
  52         @echo
  53         @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
  54
  55 dirhtml:
  56         $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
  57         @echo
  58         @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
  59
  60 pickle:
  61         $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
  62         @echo
  63         @echo "Build finished; now you can process the pickle files."
  64
  65 json:
  66         $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
  67         @echo
  68         @echo "Build finished; now you can process the JSON files."
  69
  70 htmlhelp:
  71         $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
  72         @echo
  73         @echo "Build finished; now you can run HTML Help Workshop with the" \
  74               ".hhp project file in $(BUILDDIR)/htmlhelp."
  75
  76 qthelp:
  77         $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
  78         @echo
  79         @echo "Build finished; now you can run "qcollectiongenerator" with the" \
  80               ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
  81         @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ADAO.qhcp"
  82         @echo "To view the help file:"
  83         @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ADAO.qhc"
  84
  85 latex:
  86         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  87         @echo
  88         @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
  89         @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
  90               "run these through (pdf)latex."
  91
  92 changes:
  93         $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
  94         @echo
  95         @echo "The overview file is in $(BUILDDIR)/changes."
  96
  97 linkcheck:
  98         $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
  99         @echo
 100         @echo "Link check complete; look for any errors in the above output " \
 101               "or in $(BUILDDIR)/linkcheck/output.txt."
 102
 103 doctest:
 104         $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
 105         @echo "Testing of doctests in the sources finished, look at the " \
 106               "results in $(BUILDDIR)/doctest/output.txt."