granicus.if.org Git - clang/blob - docs/Makefile.sphinx

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