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