doc/Makefile

   1 # Makefile for Sphinx documentation
   2 #
   3
   4 # You can set these variables from the command line.
   5 SPHINXOPTS    =
   6 SPHINXBUILD   = sphinx-build
   7 PAPER         =
   8 BUILDDIR      = build
   9
  10 # Internal variables.
  11 PAPEROPT_a4     = -D latex_paper_size=a4
  12 PAPEROPT_letter = -D latex_paper_size=letter
  13 ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) src
  14 SILENT          = &>/dev/null
  15
  16 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
  17
  18 help:
  19         @echo "Please use \`make <target>' where <target> is one of"
  20         @echo "  html       to make standalone HTML files"
  21         @echo "  dirhtml    to make HTML files named index.html in directories"
  22         @echo "  singlehtml to make a single large HTML file"
  23         @echo "  pickle     to make pickle files"
  24         @echo "  json       to make JSON files"
  25         @echo "  htmlhelp   to make HTML files and a HTML help project"
  26         @echo "  qthelp     to make HTML files and a qthelp project"
  27         @echo "  devhelp    to make HTML files and a Devhelp project"
  28         @echo "  epub       to make an epub"
  29         @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
  30         @echo "  latexpdf   to make LaTeX files and run them through pdflatex"
  31         @echo "  text       to make text files"
  32         @echo "  man        to make manual pages"
  33         @echo "  changes    to make an overview of all changed/added/deprecated items"
  34         @echo "  linkcheck  to check all external links for integrity"
  35         @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
  36
  37 clean:
  38         -rm -rf $(BUILDDIR)/*
  39
  40 html: apidoc
  41         $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
  42         @echo
  43         @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
  44
  45 clean-html:
  46         make clean
  47         make html
  48
  49 dirhtml:
  50         $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
  51         @echo
  52         @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
  53
  54 singlehtml:
  55         $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
  56         @echo
  57         @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
  58
  59 pickle:
  60         $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
  61         @echo
  62         @echo "Build finished; now you can process the pickle files."
  63
  64 json:
  65         $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
  66         @echo
  67         @echo "Build finished; now you can process the JSON files."
  68
  69 htmlhelp:
  70         $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
  71         @echo
  72         @echo "Build finished; now you can run HTML Help Workshop with the" \
  73               ".hhp project file in $(BUILDDIR)/htmlhelp."
  74
  75 qthelp:
  76         $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
  77         @echo
  78         @echo "Build finished; now you can run "qcollectiongenerator" with the" \
  79               ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
  80         @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/salomeTools.qhcp"
  81         @echo "To view the help file:"
  82         @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/salomeTools.qhc"
  83
  84 devhelp:
  85         $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
  86         @echo
  87         @echo "Build finished."
  88         @echo "To view the help file:"
  89         @echo "# mkdir -p $$HOME/.local/share/devhelp/salomeTools"
  90         @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/salomeTools"
  91         @echo "# devhelp"
  92
  93 epub:
  94         $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
  95         @echo
  96         @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
  97
  98 latex:
  99         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 100         @echo
 101         @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
 102         @echo "Run \`make' in that directory to run these through (pdf)latex" \
 103               "(use \`make latexpdf' here to do that automatically)."
 104
 105 latexpdf:
 106         $(SPHINXBUILD) -q -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 107         @echo "Running LaTeX files through pdflatex..."
 108         make -C $(BUILDDIR)/latex all-pdf $(SILENT)
 109         @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
 110
 111 clean-pdf:
 112         make clean
 113         make latexpdf
 114
 115 text:
 116         $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
 117         @echo
 118         @echo "Build finished. The text files are in $(BUILDDIR)/text."
 119
 120 man:
 121         $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
 122         @echo
 123         @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
 124
 125 changes:
 126         $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
 127         @echo
 128         @echo "The overview file is in $(BUILDDIR)/changes."
 129
 130 linkcheck:
 131         $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
 132         @echo
 133         @echo "Link check complete; look for any errors in the above output " \
 134               "or in $(BUILDDIR)/linkcheck/output.txt."
 135
 136 doctest:
 137         $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
 138         @echo "Testing of doctests in the sources finished, look at the " \
 139               "results in $(BUILDDIR)/doctest/output.txt."
 140
 141 apidoc:
 142         @sphinx-apidoc -o src/commands/apidoc ../src