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