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