Makefile (7350B)
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. You can find Sphinx at 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 gettext 23 .PHONY: texinfo-exchange 24 25 help: 26 @echo "Please use \`make <target>' where <target> is one of" 27 @echo " html to make standalone HTML files" 28 @echo " dirhtml to make HTML files named index.html in directories" 29 @echo " singlehtml to make a single large HTML file" 30 @echo " pickle to make pickle files" 31 @echo " json to make JSON files" 32 @echo " htmlhelp to make HTML files and a HTML help project" 33 @echo " qthelp to make HTML files and a qthelp project" 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 50 clean: 51 rm -rf $(BUILDDIR)/* 52 53 .PHONY: diagrams 54 diagrams: 55 $(MAKE) -C images/ 56 57 58 # The html-linked builder does not support caching, so we 59 # remove all cached state first. 60 html: diagrams 61 # -W = exit 1 on warning; --keep-going = complete build anyway; -w /tmp/sphinx-warnings.log = write log to ~/warnings.log 62 $(SPHINXBUILD) -b html-linked $(ALLSPHINXOPTS) $(BUILDDIR)/html 63 @echo 64 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." 65 66 dirhtml: 67 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml 68 @echo 69 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." 70 71 singlehtml: 72 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml 73 @echo 74 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." 75 76 pickle: 77 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle 78 @echo 79 @echo "Build finished; now you can process the pickle files." 80 81 json: 82 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json 83 @echo 84 @echo "Build finished; now you can process the JSON files." 85 86 htmlhelp: 87 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp 88 @echo 89 @echo "Build finished; now you can run HTML Help Workshop with the" \ 90 ".hhp project file in $(BUILDDIR)/htmlhelp." 91 92 qthelp: 93 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp 94 @echo 95 @echo "Build finished; now you can run "qcollectiongenerator" with the" \ 96 ".qhcp project file in $(BUILDDIR)/qthelp, like this:" 97 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/neuro.qhcp" 98 @echo "To view the help file:" 99 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/neuro.qhc" 100 101 devhelp: 102 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp 103 @echo 104 @echo "Build finished." 105 @echo "To view the help file:" 106 @echo "# mkdir -p $$HOME/.local/share/devhelp/neuro" 107 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/neuro" 108 @echo "# devhelp" 109 110 epub: diagrams 111 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub 112 @echo 113 @echo "Build finished. The epub file is in $(BUILDDIR)/epub." 114 115 latex: diagrams 116 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 117 @echo 118 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." 119 @echo "Run \`make' in that directory to run these through (pdf)latex" \ 120 "(use \`make latexpdf' here to do that automatically)." 121 122 latexpdf: diagrams 123 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 124 @echo "Running LaTeX files through pdflatex..." 125 $(MAKE) -C $(BUILDDIR)/latex all-pdf 126 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." 127 128 latexpdfja: diagrams 129 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 130 @echo "Running LaTeX files through platex and dvipdfmx..." 131 $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja 132 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." 133 134 text: 135 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text 136 @echo 137 @echo "Build finished. The text files are in $(BUILDDIR)/text." 138 139 man: 140 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man 141 @echo 142 @echo "Build finished. The manual pages are in $(BUILDDIR)/man." 143 144 texinfo: 145 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo 146 @echo 147 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." 148 @echo "Run \`make' in that directory to run these through makeinfo" \ 149 "(use \`make info' here to do that automatically)." 150 151 texinfo-exchange: 152 $(SPHINXBUILD) -b texinfo . $(BUILDDIR)/texinfo-exchange ./taler-bank.rst -D master_doc=taler-exchange 153 @echo 154 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo-exchange." 155 @echo "Run \`make' in that directory to run these through makeinfo" 156 157 info: 158 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo 159 @echo "Running Texinfo files through makeinfo..." 160 make -C $(BUILDDIR)/texinfo info 161 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." 162 163 gettext: 164 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale 165 @echo 166 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." 167 168 changes: 169 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes 170 @echo 171 @echo "The overview file is in $(BUILDDIR)/changes." 172 173 linkcheck: 174 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck 175 @echo 176 @echo "Link check complete; look for any errors in the above output " \ 177 "or in $(BUILDDIR)/linkcheck/output.txt." 178 179 doctest: 180 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest 181 @echo "Testing of doctests in the sources finished, look at the " \ 182 "results in $(BUILDDIR)/doctest/output.txt." 183 184 xml: 185 $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml 186 @echo 187 @echo "Build finished. The XML files are in $(BUILDDIR)/xml." 188 189 pseudoxml: 190 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml 191 @echo 192 @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."