summaryrefslogtreecommitdiffstats
path: root/storage/mroonga/build/makefiles/sphinx.am
blob: c68f62e26ec4328eeeb679623e3737c3c61df699 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
include $(top_srcdir)/doc/files.am
include $(top_srcdir)/build/makefiles/sphinx-build.am

$(html_files): html-build-stamp
$(html_files_relative_from_locale_dir): html-build-stamp
$(man_files): man-build-stamp

am__nobase_dist_doc_locale_DATA_DIST =
if DOCUMENT_AVAILABLE
doc_localedir = $(docdir)/$(LOCALE)
nobase_dist_doc_locale_DATA =			\
	$(html_files_relative_from_locale_dir)
am__nobase_dist_doc_locale_DATA_DIST +=	\
	$(nobase_dist_doc_locale_DATA)
endif

document_source_files =				\
	$(absolute_source_files)		\
	$(absolute_theme_files)			\
	$(po_files_relative_from_locale_dir)	\
	$(mo_files_relative_from_locale_dir)

required_build_stamps =				\
	html-build-stamp			\
	man-build-stamp				\
	mo-build-stamp

if DOCUMENT_BUILDABLE
EXTRA_DIST += $(required_build_stamps)
endif

man_files =					\
	man/$(PACKAGE_NAME).1

generated_files =				\
	$(DOCTREES_BASE)			\
	man					\
	man-build-stamp				\
	html					\
	html-build-stamp			\
	pdf					\
	pdf-build-stamp				\
	dirhtml					\
	dirhtml-build-stamp			\
	pickle					\
	pikcle-build-stamp			\
	json					\
	json-build-stamp			\
	htmlhelp				\
	htmlhelp-build-stamp			\
	qthelp					\
	qthelp-build-stamp			\
	latex					\
	latex-build-stamp			\
	changes					\
	changes-build-stamp			\
	linkcheck				\
	linkcheck-build-stamp			\
	doctest

$(mo_files_relative_from_locale_dir): mo-build-stamp

mo-build-stamp: $(po_files_relative_from_locale_dir)
	cd LC_MESSAGES && $(MAKE) build
	@touch $@

if DOCUMENT_BUILDABLE
clean-local: $(clean_targets) clean-doctrees

clean-doctrees:
	rm -rf $(DOCTREES_BASE)

maintainer-clean-local:
	rm -rf -- $(generated_files)
endif

.PHONY: help
.PHONY: man clean-man
.PHONY: html clean-html
.PHONY: pdf
.PHONY: dirhtml
.PHONY: pickle
.PHONY: json
.PHONY: htmlhelp
.PHONY: qthelp
.PHONY: latex
.PHONY: changes
.PHONY: linkcheck
.PHONY: doctest

if DOCUMENT_BUILDABLE
help:
	@echo "Please use \`make <target>' where <target> is one of"
	@echo "  man       to make man files"
	@echo "  html      to make standalone HTML files"
	@echo "  dirhtml   to make HTML files named index.html in directories"
	@echo "  pickle    to make pickle files"
	@echo "  json      to make JSON files"
	@echo "  htmlhelp  to make HTML files and a HTML help project"
	@echo "  qthelp    to make HTML files and a qthelp project"
	@echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
	@echo "  rdoc      to make RDoc files"
	@echo "  textile   to make Textile files"
	@echo "  changes   to make an overview of all changed/added/deprecated items"
	@echo "  linkcheck to check all external links for integrity"
	@echo "  doctest   to run all doctests embedded in the documentation (if enabled)"

man: man-build-stamp
html: html-recursive html-build-stamp
dirhtml: dirhtml-build-stamp
pickle: pickle-build-stamp
json: json-build-stamp
htmlhelp: htmlhelp-build-stamp
qthelp: qthelp-build-stamp
latex: latex-build-stamp
rdoc: rdoc-build-stamp
textile: textile-build-stamp
changes: changes-build-stamp
linkcheck: linkcheck-build-stamp
doctest: doctest-build-stamp

clean_targets =					\
	clean-man				\
	clean-html				\
	clean-dirhtml				\
	clean-pickle				\
	clean-json				\
	clean-htmlhelp				\
	clean-qthelp				\
	clean-latex				\
	clean-rdoc				\
	clean-textile				\
	clean-changes				\
	clean-linkcheck				\
	clean-doctest

$(clean_targets):
	target=`echo $@ | sed -e 's/^clean-//'`;	\
	  rm -rf $${target}-build-stamp $${target}

build_stamps =					\
	man-build-stamp				\
	html-build-stamp			\
	dirhtml-build-stamp			\
	pickle-build-stamp			\
	json-build-stamp			\
	htmlhelp-build-stamp			\
	qthelp-build-stamp			\
	latex-build-stamp			\
	rdoc-build-stamp			\
	textile-build-stamp			\
	changes-build-stamp			\
	linkcheck-build-stamp			\
	doctest-build-stamp

$(build_stamps): $(document_source_files)
	target=`echo $@ | sed -e 's/-build-stamp$$//'`;	\
	  $(SPHINX_BUILD_COMMAND)			\
	    -Dlanguage=$(LOCALE)			\
	    -d $(DOCTREES_BASE)/$${target}		\
	    -b $${target}				\
	    $(ALLSPHINXOPTS)				\
	    $${target}
	@touch $@

qthelp: qthelp-message
qthelp-message: qthelp-build-stamp
	@echo "Build finished; now you can run 'qcollectiongenerator' with the" \
	      ".qhcp project file in qthelp/*, like this:"
	@echo "# qcollectiongenerator qthelp/groonga.qhcp"
	@echo "To view the help file:"
	@echo "# assistant -collectionFile qthelp/groonga.qhc"

latex: latex-message
latex-message: latex-build-stamp
	@echo "Build finished; the LaTeX files are in latex/*."
	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
	      "run these through (pdf)latex."
endif