OLD | NEW |
1 # Makefile for Sphinx documentation | 1 # Makefile for Sphinx documentation |
2 # | 2 # |
3 | 3 |
4 # You can set these variables from the command line. | 4 # You can set these variables from the command line. |
5 SPHINXOPTS = | 5 SPHINXOPTS = |
6 SPHINXBUILD = sphinx-build | 6 SPHINXBUILD = sphinx-build |
7 PAPER = | 7 PAPER = |
8 BUILDDIR = _build | 8 BUILDDIR = _build |
9 | 9 |
10 # Internal variables. | 10 # Internal variables. |
11 PAPEROPT_a4 = -D latex_paper_size=a4 | 11 PAPEROPT_a4 = -D latex_paper_size=a4 |
12 PAPEROPT_letter = -D latex_paper_size=letter | 12 PAPEROPT_letter = -D latex_paper_size=letter |
13 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . | 13 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . |
14 | 14 |
15 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp e
pub latex latexpdf text man changes linkcheck doctest | 15 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp e
pub latex latexpdf text man changes linkcheck doctest |
16 | 16 |
| 17 default: html |
| 18 |
17 help: | 19 help: |
18 @echo "Please use \`make <target>' where <target> is one of" | 20 @echo "Please use \`make <target>' where <target> is one of" |
19 @echo " html to make standalone HTML files" | 21 @echo " html to make standalone HTML files" |
20 @echo " dirhtml to make HTML files named index.html in directories" | 22 @echo " dirhtml to make HTML files named index.html in directories" |
21 @echo " singlehtml to make a single large HTML file" | 23 @echo " singlehtml to make a single large HTML file" |
22 @echo " pickle to make pickle files" | 24 @echo " pickle to make pickle files" |
23 @echo " json to make JSON files" | 25 @echo " json to make JSON files" |
24 @echo " htmlhelp to make HTML files and a HTML help project" | 26 @echo " htmlhelp to make HTML files and a HTML help project" |
25 @echo " qthelp to make HTML files and a qthelp project" | 27 @echo " qthelp to make HTML files and a qthelp project" |
26 @echo " devhelp to make HTML files and a Devhelp project" | 28 @echo " devhelp to make HTML files and a Devhelp project" |
(...skipping 38 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
65 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp | 67 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp |
66 @echo | 68 @echo |
67 @echo "Build finished; now you can run HTML Help Workshop with the" \ | 69 @echo "Build finished; now you can run HTML Help Workshop with the" \ |
68 ".hhp project file in $(BUILDDIR)/htmlhelp." | 70 ".hhp project file in $(BUILDDIR)/htmlhelp." |
69 | 71 |
70 qthelp: | 72 qthelp: |
71 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp | 73 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp |
72 @echo | 74 @echo |
73 @echo "Build finished; now you can run "qcollectiongenerator" with the"
\ | 75 @echo "Build finished; now you can run "qcollectiongenerator" with the"
\ |
74 ".qhcp project file in $(BUILDDIR)/qthelp, like this:" | 76 ".qhcp project file in $(BUILDDIR)/qthelp, like this:" |
75 » @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/six.qhcp" | 77 » @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Python-RSA.qhcp" |
76 @echo "To view the help file:" | 78 @echo "To view the help file:" |
77 » @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/six.qhc" | 79 » @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Python-RSA.qhc" |
78 | 80 |
79 devhelp: | 81 devhelp: |
80 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp | 82 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp |
81 @echo | 83 @echo |
82 @echo "Build finished." | 84 @echo "Build finished." |
83 @echo "To view the help file:" | 85 @echo "To view the help file:" |
84 » @echo "# mkdir -p $$HOME/.local/share/devhelp/six" | 86 » @echo "# mkdir -p $$HOME/.local/share/devhelp/Python-RSA" |
85 » @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/six" | 87 » @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Python-RS
A" |
86 @echo "# devhelp" | 88 @echo "# devhelp" |
87 | 89 |
88 epub: | 90 epub: |
89 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub | 91 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub |
90 @echo | 92 @echo |
91 @echo "Build finished. The epub file is in $(BUILDDIR)/epub." | 93 @echo "Build finished. The epub file is in $(BUILDDIR)/epub." |
92 | 94 |
93 latex: | 95 latex: |
94 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex | 96 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex |
95 @echo | 97 @echo |
(...skipping 25 matching lines...) Expand all Loading... |
121 linkcheck: | 123 linkcheck: |
122 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck | 124 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck |
123 @echo | 125 @echo |
124 @echo "Link check complete; look for any errors in the above output " \ | 126 @echo "Link check complete; look for any errors in the above output " \ |
125 "or in $(BUILDDIR)/linkcheck/output.txt." | 127 "or in $(BUILDDIR)/linkcheck/output.txt." |
126 | 128 |
127 doctest: | 129 doctest: |
128 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest | 130 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest |
129 @echo "Testing of doctests in the sources finished, look at the " \ | 131 @echo "Testing of doctests in the sources finished, look at the " \ |
130 "results in $(BUILDDIR)/doctest/output.txt." | 132 "results in $(BUILDDIR)/doctest/output.txt." |
| 133 |
| 134 upload: html |
| 135 @echo |
| 136 @echo "UPLOADING to webserver" |
| 137 @echo |
| 138 rsync _build/html/* sybren@stuvel.eu:stuvel.eu/manager/files/python-rsa-
doc/ -va |
| 139 |
OLD | NEW |