1760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org# Makefile for Sphinx documentation 2760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org# 3760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org 4760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org# You can set these variables from the command line. 5760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.orgSPHINXOPTS = 6760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.orgSPHINXBUILD = sphinx-build 7760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.orgPAPER = 8760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.orgBUILDDIR = build 9760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org 10760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org# Internal variables. 11760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.orgPAPEROPT_a4 = -D latex_paper_size=a4 12760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.orgPAPEROPT_letter = -D latex_paper_size=letter 13760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.orgALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source 14760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org 15760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest 16760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org 17760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.orghelp: 18760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo "Please use \`make <target>' where <target> is one of" 19760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo " html to make standalone HTML files" 20760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo " dirhtml to make HTML files named index.html in directories" 21760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo " pickle to make pickle files" 22760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo " json to make JSON files" 23760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo " htmlhelp to make HTML files and a HTML help project" 24760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo " qthelp to make HTML files and a qthelp project" 25760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" 26760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo " changes to make an overview of all changed/added/deprecated items" 27760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo " linkcheck to check all external links for integrity" 28760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo " doctest to run all doctests embedded in the documentation (if enabled)" 29760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org 30760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.orgclean: 31760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org -rm -rf $(BUILDDIR)/* 32760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org 33760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.orghtml: 34760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html 35760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo 36760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." 37760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org 38760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.orgdirhtml: 39760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml 40760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo 41760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." 42760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org 43760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.orgpickle: 44760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle 45760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo 46760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo "Build finished; now you can process the pickle files." 47760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org 48760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.orgjson: 49760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json 50760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo 51760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo "Build finished; now you can process the JSON files." 52760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org 53760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.orghtmlhelp: 54760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp 55760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo 56760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo "Build finished; now you can run HTML Help Workshop with the" \ 57760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org ".hhp project file in $(BUILDDIR)/htmlhelp." 58760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org 59760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.orgqthelp: 60760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp 61760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo 62760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo "Build finished; now you can run "qcollectiongenerator" with the" \ 63760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org ".qhcp project file in $(BUILDDIR)/qthelp, like this:" 64760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Gallium.qhcp" 65760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo "To view the help file:" 66760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Gallium.qhc" 67760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org 68760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.orglatex: 69760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 70760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo 71760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." 72760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ 73760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org "run these through (pdf)latex." 74760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org 75760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.orgchanges: 76760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes 77760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo 78760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo "The overview file is in $(BUILDDIR)/changes." 79760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org 80760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.orglinkcheck: 81760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck 82760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo 83760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo "Link check complete; look for any errors in the above output " \ 84760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org "or in $(BUILDDIR)/linkcheck/output.txt." 85760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org 86760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.orgdoctest: 87760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest 88760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org @echo "Testing of doctests in the sources finished, look at the " \ 89760fd893ba809a7a5daa25c2749ff502f7186e83kbr@chromium.org "results in $(BUILDDIR)/doctest/output.txt." 90