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