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