|
| 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 | +# Internal variables. |
| 11 | +PAPEROPT_a4 = -D latex_paper_size=a4 |
| 12 | +PAPEROPT_letter = -D latex_paper_size=letter |
| 13 | +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . |
| 14 | + |
| 15 | +export PYTHONPATH:= ${PYTHONPATH}:${PWD}/../:${PWD}/_ext |
| 16 | + |
| 17 | +.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest |
| 18 | + |
| 19 | +help: |
| 20 | + @echo "Please use \`make <target>' where <target> is one of" |
| 21 | + @echo " html to make standalone HTML files" |
| 22 | + @echo " dirhtml to make HTML files named index.html in directories" |
| 23 | + @echo " pickle to make pickle files" |
| 24 | + @echo " json to make JSON files" |
| 25 | + @echo " htmlhelp to make HTML files and a HTML help project" |
| 26 | + @echo " qthelp to make HTML files and a qthelp project" |
| 27 | + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" |
| 28 | + @echo " changes to make an overview of all changed/added/deprecated items" |
| 29 | + @echo " linkcheck to check all external links for integrity" |
| 30 | + @echo " doctest to run all doctests embedded in the documentation (if enabled)" |
| 31 | + |
| 32 | +clean: |
| 33 | + -rm -rf $(BUILDDIR)/* |
| 34 | + |
| 35 | +html: clean |
| 36 | + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html |
| 37 | + @echo |
| 38 | + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." |
| 39 | + |
| 40 | +dirhtml: |
| 41 | + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml |
| 42 | + @echo |
| 43 | + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." |
| 44 | + |
| 45 | +pickle: |
| 46 | + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle |
| 47 | + @echo |
| 48 | + @echo "Build finished; now you can process the pickle files." |
| 49 | + |
| 50 | +json: |
| 51 | + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json |
| 52 | + @echo |
| 53 | + @echo "Build finished; now you can process the JSON files." |
| 54 | + |
| 55 | +htmlhelp: |
| 56 | + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp |
| 57 | + @echo |
| 58 | + @echo "Build finished; now you can run HTML Help Workshop with the" \ |
| 59 | + ".hhp project file in $(BUILDDIR)/htmlhelp." |
| 60 | + |
| 61 | +qthelp: |
| 62 | + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp |
| 63 | + @echo |
| 64 | + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ |
| 65 | + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" |
| 66 | + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/as.qhcp" |
| 67 | + @echo "To view the help file:" |
| 68 | + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/as.qhc" |
| 69 | + |
| 70 | +latex: |
| 71 | + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex |
| 72 | + @echo |
| 73 | + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." |
| 74 | + @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ |
| 75 | + "run these through (pdf)latex." |
| 76 | + |
| 77 | +changes: |
| 78 | + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes |
| 79 | + @echo |
| 80 | + @echo "The overview file is in $(BUILDDIR)/changes." |
| 81 | + |
| 82 | +linkcheck: |
| 83 | + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck |
| 84 | + @echo |
| 85 | + @echo "Link check complete; look for any errors in the above output " \ |
| 86 | + "or in $(BUILDDIR)/linkcheck/output.txt." |
| 87 | + |
| 88 | +doctest: |
| 89 | + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest |
| 90 | + @echo "Testing of doctests in the sources finished, look at the " \ |
| 91 | + "results in $(BUILDDIR)/doctest/output.txt." |
0 commit comments