root / docs / Makefile @ f5c86c34
History | View | Annotate | Download (4.5 kB)
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) source |
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: |
37 |
-rm -rf $(BUILDDIR)/* |
38 |
|
39 |
html: |
40 |
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html |
41 |
@echo |
42 |
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html." |
43 |
|
44 |
dirhtml: |
45 |
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml |
46 |
@echo |
47 |
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." |
48 |
|
49 |
singlehtml: |
50 |
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml |
51 |
@echo |
52 |
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." |
53 |
|
54 |
pickle: |
55 |
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle |
56 |
@echo |
57 |
@echo "Build finished; now you can process the pickle files." |
58 |
|
59 |
json: |
60 |
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json |
61 |
@echo |
62 |
@echo "Build finished; now you can process the JSON files." |
63 |
|
64 |
htmlhelp: |
65 |
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp |
66 |
@echo |
67 |
@echo "Build finished; now you can run HTML Help Workshop with the" \ |
68 |
".hhp project file in $(BUILDDIR)/htmlhelp." |
69 |
|
70 |
qthelp: |
71 |
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp |
72 |
@echo |
73 |
@echo "Build finished; now you can run "qcollectiongenerator" with the" \ |
74 |
".qhcp project file in $(BUILDDIR)/qthelp, like this:" |
75 |
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PithosWebClient.qhcp" |
76 |
@echo "To view the help file:" |
77 |
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PithosWebClient.qhc" |
78 |
|
79 |
devhelp: |
80 |
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp |
81 |
@echo |
82 |
@echo "Build finished." |
83 |
@echo "To view the help file:" |
84 |
@echo "# mkdir -p $$HOME/.local/share/devhelp/PithosWebClient" |
85 |
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PithosWebClient" |
86 |
@echo "# devhelp" |
87 |
|
88 |
epub: |
89 |
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub |
90 |
@echo |
91 |
@echo "Build finished. The epub file is in $(BUILDDIR)/epub." |
92 |
|
93 |
latex: |
94 |
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex |
95 |
@echo |
96 |
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." |
97 |
@echo "Run \`make' in that directory to run these through (pdf)latex" \ |
98 |
"(use \`make latexpdf' here to do that automatically)." |
99 |
|
100 |
latexpdf: |
101 |
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex |
102 |
@echo "Running LaTeX files through pdflatex..." |
103 |
make -C $(BUILDDIR)/latex all-pdf |
104 |
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." |
105 |
|
106 |
text: |
107 |
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text |
108 |
@echo |
109 |
@echo "Build finished. The text files are in $(BUILDDIR)/text." |
110 |
|
111 |
man: |
112 |
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man |
113 |
@echo |
114 |
@echo "Build finished. The manual pages are in $(BUILDDIR)/man." |
115 |
|
116 |
changes: |
117 |
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes |
118 |
@echo |
119 |
@echo "The overview file is in $(BUILDDIR)/changes." |
120 |
|
121 |
linkcheck: |
122 |
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck |
123 |
@echo |
124 |
@echo "Link check complete; look for any errors in the above output " \ |
125 |
"or in $(BUILDDIR)/linkcheck/output.txt." |
126 |
|
127 |
doctest: |
128 |
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest |
129 |
@echo "Testing of doctests in the sources finished, look at the " \ |
130 |
"results in $(BUILDDIR)/doctest/output.txt." |