10f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva# Makefile for Sphinx documentation 20f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva# 30f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva 40f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva# You can set these variables from the command line. 50f48f9d5548b0617d6f17d11727d752aecb7da0cSean SilvaSPHINXOPTS = 60f48f9d5548b0617d6f17d11727d752aecb7da0cSean SilvaSPHINXBUILD = sphinx-build 70f48f9d5548b0617d6f17d11727d752aecb7da0cSean SilvaPAPER = 80f48f9d5548b0617d6f17d11727d752aecb7da0cSean SilvaBUILDDIR = _build 90f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva 100f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva# Internal variables. 110f48f9d5548b0617d6f17d11727d752aecb7da0cSean SilvaPAPEROPT_a4 = -D latex_paper_size=a4 120f48f9d5548b0617d6f17d11727d752aecb7da0cSean SilvaPAPEROPT_letter = -D latex_paper_size=letter 130f48f9d5548b0617d6f17d11727d752aecb7da0cSean SilvaALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . 140f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva# the i18n builder cannot share the environment and doctrees with the others 150f48f9d5548b0617d6f17d11727d752aecb7da0cSean SilvaI18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . 160f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva 170f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext 180f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva 190f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silvadefault: html 200f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva 210f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silvahelp: 220f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo "Please use \`make <target>' where <target> is one of" 230f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo " html to make standalone HTML files" 240f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo " dirhtml to make HTML files named index.html in directories" 250f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo " singlehtml to make a single large HTML file" 260f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo " pickle to make pickle files" 270f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo " json to make JSON files" 280f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo " htmlhelp to make HTML files and a HTML help project" 290f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo " qthelp to make HTML files and a qthelp project" 300f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo " devhelp to make HTML files and a Devhelp project" 310f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo " epub to make an epub" 320f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" 330f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo " latexpdf to make LaTeX files and run them through pdflatex" 340f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo " text to make text files" 350f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo " man to make manual pages" 360f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo " texinfo to make Texinfo files" 370f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo " info to make Texinfo files and run them through makeinfo" 380f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo " gettext to make PO message catalogs" 390f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo " changes to make an overview of all changed/added/deprecated items" 400f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo " linkcheck to check all external links for integrity" 410f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo " doctest to run all doctests embedded in the documentation (if enabled)" 420f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva 430f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silvaclean: 440f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva -rm -rf $(BUILDDIR)/* 450f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva 460f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silvahtml: 470f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html 480f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo 490f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." 500f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva 510f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silvadirhtml: 520f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml 530f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo 540f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." 550f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva 560f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silvasinglehtml: 570f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml 580f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo 590f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." 600f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva 610f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silvapickle: 620f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle 630f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo 640f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo "Build finished; now you can process the pickle files." 650f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva 660f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silvajson: 670f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json 680f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo 690f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo "Build finished; now you can process the JSON files." 700f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva 710f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silvahtmlhelp: 720f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp 730f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo 740f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo "Build finished; now you can run HTML Help Workshop with the" \ 750f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva ".hhp project file in $(BUILDDIR)/htmlhelp." 760f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva 770f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silvaqthelp: 780f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp 790f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo 800f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo "Build finished; now you can run "qcollectiongenerator" with the" \ 810f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva ".qhcp project file in $(BUILDDIR)/qthelp, like this:" 820f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ClangStaticAnalyzer.qhcp" 830f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo "To view the help file:" 840f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ClangStaticAnalyzer.qhc" 850f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva 860f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silvadevhelp: 870f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp 880f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo 890f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo "Build finished." 900f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo "To view the help file:" 910f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo "# mkdir -p $$HOME/.local/share/devhelp/ClangStaticAnalyzer" 920f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ClangStaticAnalyzer" 930f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo "# devhelp" 940f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva 950f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silvaepub: 960f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub 970f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo 980f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo "Build finished. The epub file is in $(BUILDDIR)/epub." 990f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva 1000f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silvalatex: 1010f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 1020f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo 1030f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." 1040f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo "Run \`make' in that directory to run these through (pdf)latex" \ 1050f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva "(use \`make latexpdf' here to do that automatically)." 1060f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva 1070f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silvalatexpdf: 1080f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 1090f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo "Running LaTeX files through pdflatex..." 1100f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva $(MAKE) -C $(BUILDDIR)/latex all-pdf 1110f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." 1120f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva 1130f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silvatext: 1140f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text 1150f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo 1160f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo "Build finished. The text files are in $(BUILDDIR)/text." 1170f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva 1180f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silvaman: 1190f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man 1200f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo 1210f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo "Build finished. The manual pages are in $(BUILDDIR)/man." 1220f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva 1230f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silvatexinfo: 1240f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo 1250f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo 1260f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." 1270f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo "Run \`make' in that directory to run these through makeinfo" \ 1280f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva "(use \`make info' here to do that automatically)." 1290f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva 1300f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silvainfo: 1310f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo 1320f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo "Running Texinfo files through makeinfo..." 1330f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva make -C $(BUILDDIR)/texinfo info 1340f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." 1350f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva 1360f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silvagettext: 1370f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale 1380f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo 1390f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." 1400f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva 1410f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silvachanges: 1420f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes 1430f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo 1440f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo "The overview file is in $(BUILDDIR)/changes." 1450f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva 1460f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silvalinkcheck: 1470f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck 1480f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo 1490f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo "Link check complete; look for any errors in the above output " \ 1500f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva "or in $(BUILDDIR)/linkcheck/output.txt." 1510f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva 1520f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silvadoctest: 1530f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest 1540f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva @echo "Testing of doctests in the sources finished, look at the " \ 1550f48f9d5548b0617d6f17d11727d752aecb7da0cSean Silva "results in $(BUILDDIR)/doctest/output.txt." 156