1# Makefile for Sphinx documentation 2# 3 4# You can set these variables from the command line. 5SPHINXOPTS = 6SPHINXBUILD = sphinx-build 7PAPER = 8BUILDDIR = build 9SOURCEDIR = source 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) $(SOURCEDIR) 15# the i18n builder cannot share the environment and doctrees with the others 16I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCEDIR) 17 18.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext fig 19 20help: 21 @echo "Please use \`make <target>' where <target> is one of" 22 @echo " html to make standalone HTML files" 23 @echo " dirhtml to make HTML files named index.html in directories" 24 @echo " singlehtml to make a single large HTML file" 25 @echo " pickle to make pickle files" 26 @echo " json to make JSON files" 27 @echo " htmlhelp to make HTML files and a HTML help project" 28 @echo " qthelp to make HTML files and a qthelp project" 29 @echo " devhelp to make HTML files and a Devhelp project" 30 @echo " epub to make an epub" 31 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" 32 @echo " latexpdf to make LaTeX files and run them through pdflatex" 33 @echo " text to make text files" 34 @echo " man to make manual pages" 35 @echo " texinfo to make Texinfo files" 36 @echo " info to make Texinfo files and run them through makeinfo" 37 @echo " gettext to make PO message catalogs" 38 @echo " changes to make an overview of all changed/added/deprecated items" 39 @echo " linkcheck to check all external links for integrity" 40 @echo " doctest to run all doctests embedded in the documentation (if enabled)" 41 42clean: 43 -rm -rf $(BUILDDIR)/* 44 45html: basefig MANY_CLUSTER.png 46 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html 47 @echo 48 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." 49 50dirhtml: 51 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml 52 @echo 53 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." 54 55singlehtml: 56 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml 57 @echo 58 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." 59 60pickle: 61 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle 62 @echo 63 @echo "Build finished; now you can process the pickle files." 64 65json: 66 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json 67 @echo 68 @echo "Build finished; now you can process the JSON files." 69 70htmlhelp: 71 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp 72 @echo 73 @echo "Build finished; now you can run HTML Help Workshop with the" \ 74 ".hhp project file in $(BUILDDIR)/htmlhelp." 75 76qthelp: 77 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp 78 @echo 79 @echo "Build finished; now you can run "qcollectiongenerator" with the" \ 80 ".qhcp project file in $(BUILDDIR)/qthelp, like this:" 81 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pbtoolkits.qhcp" 82 @echo "To view the help file:" 83 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pbtoolkits.qhc" 84 85devhelp: 86 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp 87 @echo 88 @echo "Build finished." 89 @echo "To view the help file:" 90 @echo "# mkdir -p $$HOME/.local/share/devhelp/pbtoolkits" 91 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pbtoolkits" 92 @echo "# devhelp" 93 94epub: 95 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub 96 @echo 97 @echo "Build finished. The epub file is in $(BUILDDIR)/epub." 98 99latex: 100 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 101 @echo 102 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." 103 @echo "Run \`make' in that directory to run these through (pdf)latex" \ 104 "(use \`make latexpdf' here to do that automatically)." 105 106latexpdf: 107 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 108 @echo "Running LaTeX files through pdflatex..." 109 $(MAKE) -C $(BUILDDIR)/latex all-pdf 110 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." 111 112text: 113 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text 114 @echo 115 @echo "Build finished. The text files are in $(BUILDDIR)/text." 116 117man: 118 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man 119 @echo 120 @echo "Build finished. The manual pages are in $(BUILDDIR)/man." 121 122texinfo: 123 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo 124 @echo 125 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." 126 @echo "Run \`make' in that directory to run these through makeinfo" \ 127 "(use \`make info' here to do that automatically)." 128 129info: 130 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo 131 @echo "Running Texinfo files through makeinfo..." 132 make -C $(BUILDDIR)/texinfo info 133 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." 134 135gettext: 136 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale 137 @echo 138 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." 139 140changes: 141 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes 142 @echo 143 @echo "The overview file is in $(BUILDDIR)/changes." 144 145linkcheck: 146 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck 147 @echo 148 @echo "Link check complete; look for any errors in the above output " \ 149 "or in $(BUILDDIR)/linkcheck/output.txt." 150 151doctest: 152 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest 153 @echo "Testing of doctests in the sources finished, look at the " \ 154 "results in $(BUILDDIR)/doctest/output.txt." 155 156basefig: 157 dot -Tpng $(SOURCEDIR)/dependencies.dot > $(SOURCEDIR)/$@ 158 grep -v "\"pbsmrtpipe\" ->" $(SOURCEDIR)/dependencies.dot \ 159 | grep -v "> \"pbcore\"" \ 160 | sed 's/All/Sparse/' > $(SOURCEDIR)/sparse_dependencies.dot 161 dot -Tpng $(SOURCEDIR)/sparse_dependencies.dot \ 162 > $(SOURCEDIR)/sparse_dependencies.png 163 164%.png: basefig 165 grep -v $* $(SOURCEDIR)/sparse_dependencies.dot | \ 166 grep -v \? | sed 's/Sparse dependencies/Module bundles/' | \ 167 dot -Tpng > $(SOURCEDIR)/$@ 168 169