[7116b6e0] | 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 | .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest |
---|
| 16 | |
---|
| 17 | help: |
---|
| 18 | @echo "Please use \`make <target>' where <target> is one of" |
---|
| 19 | @echo " html to make standalone HTML files" |
---|
| 20 | @echo " dirhtml to make HTML files named index.html in directories" |
---|
| 21 | @echo " singlehtml to make a single large HTML file" |
---|
| 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 " devhelp to make HTML files and a Devhelp project" |
---|
| 27 | @echo " epub to make an epub" |
---|
| 28 | @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" |
---|
| 29 | @echo " latexpdf to make LaTeX files and run them through pdflatex" |
---|
| 30 | @echo " text to make text files" |
---|
| 31 | @echo " man to make manual pages" |
---|
| 32 | @echo " changes to make an overview of all changed/added/deprecated items" |
---|
| 33 | @echo " linkcheck to check all external links for integrity" |
---|
| 34 | @echo " doctest to run all doctests embedded in the documentation (if enabled)" |
---|
| 35 | |
---|
| 36 | clean: |
---|
[b4293d2] | 37 | -rm -rf $(BUILDDIR) |
---|
| 38 | -rm -rf api |
---|
| 39 | |
---|
| 40 | stubs: |
---|
| 41 | python genmods.py |
---|
[7116b6e0] | 42 | |
---|
[b4293d2] | 43 | html: stubs |
---|
[7116b6e0] | 44 | $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html |
---|
| 45 | @echo |
---|
| 46 | @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." |
---|
| 47 | |
---|
| 48 | dirhtml: |
---|
| 49 | $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml |
---|
| 50 | @echo |
---|
| 51 | @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." |
---|
| 52 | |
---|
| 53 | singlehtml: |
---|
| 54 | $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml |
---|
| 55 | @echo |
---|
| 56 | @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." |
---|
| 57 | |
---|
| 58 | pickle: |
---|
| 59 | $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle |
---|
| 60 | @echo |
---|
| 61 | @echo "Build finished; now you can process the pickle files." |
---|
| 62 | |
---|
| 63 | json: |
---|
| 64 | $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json |
---|
| 65 | @echo |
---|
| 66 | @echo "Build finished; now you can process the JSON files." |
---|
| 67 | |
---|
| 68 | htmlhelp: |
---|
| 69 | $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp |
---|
| 70 | @echo |
---|
| 71 | @echo "Build finished; now you can run HTML Help Workshop with the" \ |
---|
| 72 | ".hhp project file in $(BUILDDIR)/htmlhelp." |
---|
| 73 | |
---|
| 74 | qthelp: |
---|
| 75 | $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp |
---|
| 76 | @echo |
---|
| 77 | @echo "Build finished; now you can run "qcollectiongenerator" with the" \ |
---|
| 78 | ".qhcp project file in $(BUILDDIR)/qthelp, like this:" |
---|
| 79 | @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/prview.qhcp" |
---|
| 80 | @echo "To view the help file:" |
---|
| 81 | @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/prview.qhc" |
---|
| 82 | |
---|
| 83 | devhelp: |
---|
| 84 | $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp |
---|
| 85 | @echo |
---|
| 86 | @echo "Build finished." |
---|
| 87 | @echo "To view the help file:" |
---|
| 88 | @echo "# mkdir -p $$HOME/.local/share/devhelp/prview" |
---|
| 89 | @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/prview" |
---|
| 90 | @echo "# devhelp" |
---|
| 91 | |
---|
| 92 | epub: |
---|
| 93 | $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub |
---|
| 94 | @echo |
---|
| 95 | @echo "Build finished. The epub file is in $(BUILDDIR)/epub." |
---|
| 96 | |
---|
| 97 | latex: |
---|
| 98 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex |
---|
| 99 | @echo |
---|
| 100 | @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." |
---|
| 101 | @echo "Run \`make' in that directory to run these through (pdf)latex" \ |
---|
| 102 | "(use \`make latexpdf' here to do that automatically)." |
---|
| 103 | |
---|
| 104 | latexpdf: latex |
---|
| 105 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex |
---|
| 106 | @echo "Running LaTeX files through pdflatex..." |
---|
| 107 | make -C $(BUILDDIR)/latex all-pdf |
---|
| 108 | @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." |
---|
| 109 | |
---|
| 110 | text: |
---|
| 111 | $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text |
---|
| 112 | @echo |
---|
| 113 | @echo "Build finished. The text files are in $(BUILDDIR)/text." |
---|
| 114 | |
---|
| 115 | man: |
---|
| 116 | $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man |
---|
| 117 | @echo |
---|
| 118 | @echo "Build finished. The manual pages are in $(BUILDDIR)/man." |
---|
| 119 | |
---|
| 120 | changes: |
---|
| 121 | $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes |
---|
| 122 | @echo |
---|
| 123 | @echo "The overview file is in $(BUILDDIR)/changes." |
---|
| 124 | |
---|
| 125 | linkcheck: |
---|
| 126 | $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck |
---|
| 127 | @echo |
---|
| 128 | @echo "Link check complete; look for any errors in the above output " \ |
---|
| 129 | "or in $(BUILDDIR)/linkcheck/output.txt." |
---|
| 130 | |
---|
| 131 | doctest: |
---|
| 132 | $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest |
---|
| 133 | @echo "Testing of doctests in the sources finished, look at the " \ |
---|
| 134 | "results in $(BUILDDIR)/doctest/output.txt." |
---|