1# Makefile for Sphinx documentation 2# 3 4# You can set these variables from the command line. 5SPHINXOPTS = 6SPHINXBUILD = sphinx-build 7SPHINXAUTOBUILD = sphinx-autobuild 8PAPER = 9BUILDDIR = build 10SRCDIR = src 11 12# User-friendly check for sphinx-build 13ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) 14$(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/) 15endif 16 17# Internal variables. 18PAPEROPT_a4 = -D latex_paper_size=a4 19PAPEROPT_letter = -D latex_paper_size=letter 20ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SRCDIR) 21# the i18n builder cannot share the environment and doctrees with the others 22I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SRCDIR) 23 24.PHONY: help clean html livehtml dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext 25 26help: 27 @echo "Please use \`make <target>' where <target> is one of" 28 @echo " html to make standalone HTML files" 29 @echo " livehtml to make standalone HTML files and live reload them" 30 @echo " dirhtml to make HTML files named index.html in directories" 31 @echo " singlehtml to make a single large HTML file" 32 @echo " pickle to make pickle files" 33 @echo " json to make JSON files" 34 @echo " htmlhelp to make HTML files and a HTML help project" 35 @echo " qthelp to make HTML files and a qthelp project" 36 @echo " devhelp to make HTML files and a Devhelp project" 37 @echo " epub to make an epub" 38 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" 39 @echo " latexpdf to make LaTeX files and run them through pdflatex" 40 @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" 41 @echo " text to make text files" 42 @echo " man to make manual pages" 43 @echo " texinfo to make Texinfo files" 44 @echo " info to make Texinfo files and run them through makeinfo" 45 @echo " gettext to make PO message catalogs" 46 @echo " changes to make an overview of all changed/added/deprecated items" 47 @echo " xml to make Docutils-native XML files" 48 @echo " pseudoxml to make pseudoxml-XML files for display purposes" 49 @echo " linkcheck to check all external links for integrity" 50 @echo " doctest to run all doctests embedded in the documentation (if enabled)" 51 52clean: 53 rm -rf $(BUILDDIR)/* 54 55html: 56 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html 57 @echo 58 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." 59 60livehtml: html 61 $(SPHINXAUTOBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html 62 63dirhtml: 64 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml 65 @echo 66 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." 67 68singlehtml: 69 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml 70 @echo 71 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." 72 73pickle: 74 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle 75 @echo 76 @echo "Build finished; now you can process the pickle files." 77 78json: 79 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json 80 @echo 81 @echo "Build finished; now you can process the JSON files." 82 83htmlhelp: 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 89qthelp: 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/libuv.qhcp" 95 @echo "To view the help file:" 96 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/libuv.qhc" 97 98devhelp: 99 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp 100 @echo 101 @echo "Build finished." 102 @echo "To view the help file:" 103 @echo "# mkdir -p $$HOME/.local/share/devhelp/libuv" 104 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/libuv" 105 @echo "# devhelp" 106 107epub: 108 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub 109 @echo 110 @echo "Build finished. The epub file is in $(BUILDDIR)/epub." 111 112latex: 113 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 114 @echo 115 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." 116 @echo "Run \`make' in that directory to run these through (pdf)latex" \ 117 "(use \`make latexpdf' here to do that automatically)." 118 119latexpdf: 120 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 121 @echo "Running LaTeX files through pdflatex..." 122 $(MAKE) -C $(BUILDDIR)/latex all-pdf 123 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." 124 125latexpdfja: 126 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 127 @echo "Running LaTeX files through platex and dvipdfmx..." 128 $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja 129 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." 130 131text: 132 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text 133 @echo 134 @echo "Build finished. The text files are in $(BUILDDIR)/text." 135 136man: 137 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man 138 @echo 139 @echo "Build finished. The manual pages are in $(BUILDDIR)/man." 140 141texinfo: 142 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo 143 @echo 144 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." 145 @echo "Run \`make' in that directory to run these through makeinfo" \ 146 "(use \`make info' here to do that automatically)." 147 148info: 149 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo 150 @echo "Running Texinfo files through makeinfo..." 151 make -C $(BUILDDIR)/texinfo info 152 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." 153 154gettext: 155 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale 156 @echo 157 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." 158 159changes: 160 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes 161 @echo 162 @echo "The overview file is in $(BUILDDIR)/changes." 163 164linkcheck: 165 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck 166 @echo 167 @echo "Link check complete; look for any errors in the above output " \ 168 "or in $(BUILDDIR)/linkcheck/output.txt." 169 170doctest: 171 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest 172 @echo "Testing of doctests in the sources finished, look at the " \ 173 "results in $(BUILDDIR)/doctest/output.txt." 174 175xml: 176 $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml 177 @echo 178 @echo "Build finished. The XML files are in $(BUILDDIR)/xml." 179 180pseudoxml: 181 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml 182 @echo 183 @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." 184
