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