Backport lots of new features from the 1.41.0 branch.
[boost:cmake.git] / tools / build / CMake / docs / Makefile.in
1 #
2 # Makefile for Sphinx documentation
3 #
4
5 # You can set these variables from the command line.
6 SPHINXOPTS    =
7 SPHINXBUILD   = sphinx-build
8 PAPER         =
9
10 # Internal variables.
11 PAPEROPT_a4     = -D latex_paper_size=a4
12 PAPEROPT_letter = -D latex_paper_size=letter
13 ALLSPHINXOPTS   = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
14
15 .PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
16
17 help:
18         @echo "Please use \`make <target>' where <target> is one of"
19         @echo "  html      to make standalone HTML files"
20         @echo "  dirhtml   to make HTML files named index.html in directories"
21         @echo "  pickle    to make pickle files"
22         @echo "  json      to make JSON files"
23         @echo "  htmlhelp  to make HTML files and a HTML help project"
24         @echo "  qthelp    to make HTML files and a qthelp project"
25         @echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
26         @echo "  changes   to make an overview of all changed/added/deprecated items"
27         @echo "  linkcheck to check all external links for integrity"
28         @echo "  doctest   to run all doctests embedded in the documentation (if enabled)"
29
30 clean:
31         -rm -rf build/*
32
33 html:
34         $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
35         @echo
36         @echo "Build finished. The HTML pages are in build/html."
37
38 dirhtml:
39         $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) build/dirhtml
40         @echo
41         @echo "Build finished. The HTML pages are in build/dirhtml."
42
43 pickle:
44         $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle
45         @echo
46         @echo "Build finished; now you can process the pickle files."
47
48 json:
49         $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) build/json
50         @echo
51         @echo "Build finished; now you can process the JSON files."
52
53 htmlhelp:
54         $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp
55         @echo
56         @echo "Build finished; now you can run HTML Help Workshop with the" \
57               ".hhp project file in build/htmlhelp."
58
59 qthelp:
60         $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) build/qthelp
61         @echo
62         @echo "Build finished; now you can run "qcollectiongenerator" with the" \
63               ".qhcp project file in build/qthelp, like this:"
64         @echo "# qcollectiongenerator build/qthelp/boost-cmake.qhcp"
65         @echo "To view the help file:"
66         @echo "# assistant -collectionFile build/qthelp/boost-cmake.qhc"
67
68 latex:
69         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex
70         @echo
71         @echo "Build finished; the LaTeX files are in build/latex."
72         @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
73               "run these through (pdf)latex."
74
75 changes:
76         $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes
77         @echo
78         @echo "The overview file is in build/changes."
79
80 linkcheck:
81         $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck
82         @echo
83         @echo "Link check complete; look for any errors in the above output " \
84               "or in build/linkcheck/output.txt."
85
86 doctest:
87         $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) build/doctest
88         @echo "Testing of doctests in the sources finished, look at the " \
89               "results in build/doctest/output.txt."
90
91 deploy:
92         make html
93         rsync --delete -va build/html/ @BOOST_CMAKE_URL@/doc/
94
95         make latex
96         make -C build/latex all-pdf
97         scp build/latex/boost-@BOOST_CMAKE_VERSION@.pdf @BOOST_CMAKE_URL@
98
99 deploy-current-docs:
100         make html
101         rsync --delete -va build/html/ @BOOST_CMAKE_HOST@:@BOOST_CMAKE_DOCROOT@/current-docs/