1 # Makefile for Sphinx documentation 2 # 3 4 # You can set these variables from the command line. 5 SPHINXOPTS = 6 SPHINXBUILD = sphinx-build 7 PAPER = 8 BUILDDIR = _build 9 10 # User-friendly check for sphinx-build 11 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) 12 $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) 13 endif 14 15 # Internal variables. 16 PAPEROPT_a4 = -D latex_paper_size=a4 17 PAPEROPT_letter = -D latex_paper_size=letter 18 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . 19 # the i18n builder cannot share the environment and doctrees with the others 20 I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . 21 22 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext 23 24 help: 25 @echo "Please use \`make <target>' where <target> is one of" 26 @echo " html to make standalone HTML files" 27 @echo " dirhtml to make HTML files named index.html in directories" 28 @echo " singlehtml to make a single large HTML file" 29 @echo " pickle to make pickle files" 30 @echo " json to make JSON files" 31 @echo " htmlhelp to make HTML files and a HTML help project" 32 @echo " qthelp to make HTML files and a qthelp project" 33 @echo " applehelp to make an Apple Help Book" 34 @echo " devhelp to make HTML files and a Devhelp project" 35 @echo " epub to make an epub" 36 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" 37 @echo " latexpdf to make LaTeX files and run them through pdflatex" 38 @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" 39 @echo " text to make text files" 40 @echo " man to make manual pages" 41 @echo " texinfo to make Texinfo files" 42 @echo " info to make Texinfo files and run them through makeinfo" 43 @echo " gettext to make PO message catalogs" 44 @echo " changes to make an overview of all changed/added/deprecated items" 45 @echo " xml to make Docutils-native XML files" 46 @echo " pseudoxml to make pseudoxml-XML files for display purposes" 47 @echo " linkcheck to check all external links for integrity" 48 @echo " doctest to run all doctests embedded in the documentation (if enabled)" 49 @echo " coverage to run coverage check of the documentation (if enabled)" 50 51 clean: 52 rm -rf $(BUILDDIR)/* 53 ls *.rst | grep -v index.rst | xargs rm -f 54 55 reference: 56 sphinx-apidoc -f -e -o . ../../bart 57 58 html: reference 59 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html 60 @echo 61 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." 62 63 dirhtml: reference 64 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml 65 @echo 66 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." 67 68 singlehtml: reference 69 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml 70 @echo 71 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." 72 73 pickle: reference 74 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle 75 @echo 76 @echo "Build finished; now you can process the pickle files." 77 78 json: reference 79 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json 80 @echo 81 @echo "Build finished; now you can process the JSON files." 82 83 htmlhelp: reference 84 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp 85 @echo 86 @echo "Build finished; now you can run HTML Help Workshop with the" \ 87 ".hhp project file in $(BUILDDIR)/htmlhelp." 88 89 qthelp: reference 90 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp 91 @echo 92 @echo "Build finished; now you can run "qcollectiongenerator" with the" \ 93 ".qhcp project file in $(BUILDDIR)/qthelp, like this:" 94 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/BART.qhcp" 95 @echo "To view the help file:" 96 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/BART.qhc" 97 98 applehelp: reference 99 $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp 100 @echo 101 @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." 102 @echo "N.B. You won't be able to view it unless you put it in" \ 103 "~/Library/Documentation/Help or install it in your application" \ 104 "bundle." 105 106 devhelp: reference 107 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp 108 @echo 109 @echo "Build finished." 110 @echo "To view the help file:" 111 @echo "# mkdir -p $$HOME/.local/share/devhelp/BART" 112 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/BART" 113 @echo "# devhelp" 114 115 epub: reference 116 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub 117 @echo 118 @echo "Build finished. The epub file is in $(BUILDDIR)/epub." 119 120 latex: reference 121 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 122 @echo 123 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." 124 @echo "Run \`make' in that directory to run these through (pdf)latex" \ 125 "(use \`make latexpdf' here to do that automatically)." 126 127 latexpdf: reference 128 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 129 @echo "Running LaTeX files through pdflatex..." 130 $(MAKE) -C $(BUILDDIR)/latex all-pdf 131 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." 132 133 latexpdfja: reference 134 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 135 @echo "Running LaTeX files through platex and dvipdfmx..." 136 $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja 137 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." 138 139 text: reference 140 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text 141 @echo 142 @echo "Build finished. The text files are in $(BUILDDIR)/text." 143 144 man: reference 145 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man 146 @echo 147 @echo "Build finished. The manual pages are in $(BUILDDIR)/man." 148 149 texinfo: reference 150 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo 151 @echo 152 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." 153 @echo "Run \`make' in that directory to run these through makeinfo" \ 154 "(use \`make info' here to do that automatically)." 155 156 info: reference 157 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo 158 @echo "Running Texinfo files through makeinfo..." 159 make -C $(BUILDDIR)/texinfo info 160 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." 161 162 gettext: reference 163 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale 164 @echo 165 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." 166 167 changes: reference 168 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes 169 @echo 170 @echo "The overview file is in $(BUILDDIR)/changes." 171 172 linkcheck: reference 173 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck 174 @echo 175 @echo "Link check complete; look for any errors in the above output " \ 176 "or in $(BUILDDIR)/linkcheck/output.txt." 177 178 doctest: reference 179 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest 180 @echo "Testing of doctests in the sources finished, look at the " \ 181 "results in $(BUILDDIR)/doctest/output.txt." 182 183 coverage: reference 184 $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage 185 @echo "Testing of coverage in the sources finished, look at the " \ 186 "results in $(BUILDDIR)/coverage/python.txt." 187 188 xml: reference 189 $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml 190 @echo 191 @echo "Build finished. The XML files are in $(BUILDDIR)/xml." 192 193 pseudoxml: reference 194 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml 195 @echo 196 @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." 197
