user_manual/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) .
  14 # the i18n builder cannot share the environment and doctrees with the others
  15 I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
  16
  17 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
  18
  19 help:
  20         @echo "Please use \`make <target>' where <target> is one of"
  21         @echo "  html       to make standalone HTML files"
  22         @echo "  dirhtml    to make HTML files named index.html in directories"
  23         @echo "  singlehtml to make a single large HTML file"
  24         @echo "  pickle     to make pickle files"
  25         @echo "  json       to make JSON files"
  26         @echo "  htmlhelp   to make HTML files and a HTML help project"
  27         @echo "  qthelp     to make HTML files and a qthelp project"
  28         @echo "  devhelp    to make HTML files and a Devhelp project"
  29         @echo "  epub       to make an epub"
  30         @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
  31         @echo "  latexpdf   to make LaTeX files and run them through pdflatex"
  32         @echo "  pdf        to make PDF files"
  33         @echo "  text       to make text files"
  34         @echo "  man        to make manual pages"
  35         @echo "  texinfo    to make Texinfo files"
  36         @echo "  info       to make Texinfo files and run them through makeinfo"
  37         @echo "  gettext    to make PO message catalogs"
  38         @echo "  changes    to make an overview of all changed/added/deprecated items"
  39         @echo "  linkcheck  to check all external links for integrity"
  40         @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
  41
  42 clean:
  43         -rm -rf $(BUILDDIR)/*
  44
  45 html:   html-org
  46
  47 html-all: html-release html-org html-com
  48
  49 html-release:
  50         $(SPHINXBUILD) -b html -D html_theme='owncloud_release' $(ALLSPHINXOPTS) $(BUILDDIR)/html/release
  51         @echo
  52         @echo "Build finished. The HTML pages are in $(BUILDDIR)/html/release."
  53
  54 html-org:
  55         $(SPHINXBUILD) -b html -D html_theme='owncloud_org' $(ALLSPHINXOPTS) $(BUILDDIR)/html/org
  56         @echo
  57         @echo "Build finished. The HTML pages are in $(BUILDDIR)/html/org."
  58
  59 html-com:
  60         $(SPHINXBUILD) -b html -D html_theme='owncloud_com' $(ALLSPHINXOPTS) $(BUILDDIR)/html/com
  61         @echo
  62         @echo "Build finished. The HTML pages are in $(BUILDDIR)/html/com."
  63
  64 dirhtml:
  65         $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
  66         @echo
  67         @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
  68
  69 singlehtml:
  70         $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
  71         @echo
  72         @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
  73
  74 pickle:
  75         $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
  76         @echo
  77         @echo "Build finished; now you can process the pickle files."
  78
  79 json:
  80         $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
  81         @echo
  82         @echo "Build finished; now you can process the JSON files."
  83
  84 htmlhelp:
  85         $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
  86         @echo
  87         @echo "Build finished; now you can run HTML Help Workshop with the" \
  88               ".hhp project file in $(BUILDDIR)/htmlhelp."
  89
  90 qthelp:
  91         $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
  92         @echo
  93         @echo "Build finished; now you can run "qcollectiongenerator" with the" \
  94               ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
  95         @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/OwncloudDocumentation.qhcp"
  96         @echo "To view the help file:"
  97         @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/OwncloudDocumentation.qhc"
  98
  99 devhelp:
 100         $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
 101         @echo
 102         @echo "Build finished."
 103         @echo "To view the help file:"
 104         @echo "# mkdir -p $$HOME/.local/share/devhelp/OwncloudDocumentation"
 105         @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/OwncloudDocumentation"
 106         @echo "# devhelp"
 107
 108 epub:
 109         $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
 110         @echo
 111         @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
 112
 113 latex:
 114         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 115         @echo
 116         @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
 117         @echo "Run \`make' in that directory to run these through (pdf)latex" \
 118               "(use \`make latexpdf' here to do that automatically)."
 119
 120 latexpdf:
 121         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 122         @echo "Running LaTeX files through pdflatex..."
 123         $(MAKE) -C $(BUILDDIR)/latex all-pdf
 124         @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
 125
 126 pdf:
 127         $(SPHINXBUILD) -b pdf $(ALLSPHINXOPTS) $(BUILDDIR)/pdf
 128         @echo
 129         @echo "build finished. the text files are in $(BUILDDIR)/pdf."
 130
 131 text:
 132         $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
 133         @echo
 134         @echo "build finished. the text files are in $(BUILDDIR)/text."
 135
 136 man:
 137         $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
 138         @echo
 139         @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
 140
 141 texinfo:
 142         $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
 143         @echo
 144         @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
 145         @echo "Run \`make' in that directory to run these through makeinfo" \
 146               "(use \`make info' here to do that automatically)."
 147
 148 info:
 149         $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
 150         @echo "Running Texinfo files through makeinfo..."
 151         make -C $(BUILDDIR)/texinfo info
 152         @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
 153
 154 gettext:
 155         $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
 156         @echo
 157         @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
 158
 159 changes:
 160         $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
 161         @echo
 162         @echo "The overview file is in $(BUILDDIR)/changes."
 163
 164 linkcheck:
 165         $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
 166         @echo
 167         @echo "Link check complete; look for any errors in the above output " \
 168               "or in $(BUILDDIR)/linkcheck/output.txt."
 169
 170 doctest:
 171         $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
 172         @echo "Testing of doctests in the sources finished, look at the " \
 173               "results in $(BUILDDIR)/doctest/output.txt."