1# Makefile for Sphinx documentation 2# 3 4# You can set these variables from the command line. 5SPHINXOPTS = 6SPHINXBUILD = sphinx-build 7PAPER = 8 9# Internal variables. 10PAPEROPT_a4 = -D latex_paper_size=a4 11PAPEROPT_letter = -D latex_paper_size=letter 12ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . 13 14DIR_PUBLISH=/ifs/home/andreas/public_html/documentation/pysam 15 16.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex 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 " pickle to make pickle files" 23 @echo " json to make JSON files" 24 @echo " htmlhelp to make HTML files and a HTML help project" 25 @echo " qthelp to make HTML files and a qthelp project" 26 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" 27 @echo " changes to make an overview of all changed/added/deprecated items" 28 @echo " linkcheck to check all external links for integrity" 29 @echo " doctest to run all doctests embedded in the documentation (if enabled)" 30 @echo " publish to copy the HTML documentation to the server." 31 32clean: 33 -rm -rf _build/* 34 35html: 36 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html 37 @echo 38 @echo "Build finished. The HTML pages are in _build/html." 39 40dirhtml: 41 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) _build/dirhtml 42 @echo 43 @echo "Build finished. The HTML pages are in _build/dirhtml." 44 45pickle: 46 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle 47 @echo 48 @echo "Build finished; now you can process the pickle files." 49 50json: 51 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json 52 @echo 53 @echo "Build finished; now you can process the JSON files." 54 55htmlhelp: 56 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp 57 @echo 58 @echo "Build finished; now you can run HTML Help Workshop with the" \ 59 ".hhp project file in _build/htmlhelp." 60 61qthelp: 62 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) _build/qthelp 63 @echo 64 @echo "Build finished; now you can run "qcollectiongenerator" with the" \ 65 ".qhcp project file in _build/qthelp, like this:" 66 @echo "# qcollectiongenerator _build/qthelp/samtools.qhcp" 67 @echo "To view the help file:" 68 @echo "# assistant -collectionFile _build/qthelp/samtools.qhc" 69 70latex: 71 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex 72 @echo 73 @echo "Build finished; the LaTeX files are in _build/latex." 74 @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ 75 "run these through (pdf)latex." 76 77changes: 78 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes 79 @echo 80 @echo "The overview file is in _build/changes." 81 82linkcheck: 83 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck 84 @echo 85 @echo "Link check complete; look for any errors in the above output " \ 86 "or in _build/linkcheck/output.txt." 87 88doctest: 89 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest 90 @echo "Testing of doctests in the sources finished, look at the " \ 91 "results in _build/doctest/output.txt." 92 93publish: 94 rm -rf $(DIR_PUBLISH) 95 mkdir -p $(DIR_PUBLISH) 96 cp -r _build/html/* $(DIR_PUBLISH) 97