1# Makefile for Sphinx documentation 2# 3 4# You can set these variables from the command line. 5SPHINXOPTS = 6SPHINXBUILD = sphinx-build 7PAPER = 8BUILDDIR = _build 9 10# Internal variables. 11PAPEROPT_a4 = -D latex_paper_size=a4 12PAPEROPT_letter = -D latex_paper_size=letter 13ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . 14 15.PHONY: html clean dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest 16 17html: 18 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html 19 @echo 20 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." 21 22dirhtml: 23 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml 24 @echo 25 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." 26 27singlehtml: 28 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml 29 @echo 30 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." 31 32pickle: 33 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle 34 @echo 35 @echo "Build finished; now you can process the pickle files." 36 37json: 38 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json 39 @echo 40 @echo "Build finished; now you can process the JSON files." 41 42htmlhelp: 43 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp 44 @echo 45 @echo "Build finished; now you can run HTML Help Workshop with the" \ 46 ".hhp project file in $(BUILDDIR)/htmlhelp." 47 48qthelp: 49 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp 50 @echo 51 @echo "Build finished; now you can run "qcollectiongenerator" with the" \ 52 ".qhcp project file in $(BUILDDIR)/qthelp, like this:" 53 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pylibmc.qhcp" 54 @echo "To view the help file:" 55 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pylibmc.qhc" 56 57devhelp: 58 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp 59 @echo 60 @echo "Build finished." 61 @echo "To view the help file:" 62 @echo "# mkdir -p $$HOME/.local/share/devhelp/pylibmc" 63 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pylibmc" 64 @echo "# devhelp" 65 66epub: 67 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub 68 @echo 69 @echo "Build finished. The epub file is in $(BUILDDIR)/epub." 70 71latex: 72 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 73 @echo 74 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." 75 @echo "Run \`make' in that directory to run these through (pdf)latex" \ 76 "(use \`make latexpdf' here to do that automatically)." 77 78latexpdf: 79 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 80 @echo "Running LaTeX files through pdflatex..." 81 make -C $(BUILDDIR)/latex all-pdf 82 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." 83 84text: 85 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text 86 @echo 87 @echo "Build finished. The text files are in $(BUILDDIR)/text." 88 89man: 90 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man 91 @echo 92 @echo "Build finished. The manual pages are in $(BUILDDIR)/man." 93 94changes: 95 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes 96 @echo 97 @echo "The overview file is in $(BUILDDIR)/changes." 98 99linkcheck: 100 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck 101 @echo 102 @echo "Link check complete; look for any errors in the above output " \ 103 "or in $(BUILDDIR)/linkcheck/output.txt." 104 105doctest: 106 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest 107 @echo "Testing of doctests in the sources finished, look at the " \ 108 "results in $(BUILDDIR)/doctest/output.txt." 109 110clean: 111 -rm -rf $(BUILDDIR)/* 112