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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
|
##########################################################################
## # The Coq Proof Assistant / The Coq Development Team ##
## v # Copyright INRIA, CNRS and contributors ##
## <O___,, # (see version control and CREDITS file for authors & dates) ##
## \VV/ ###############################################################
## // # This file is distributed under the terms of the ##
## # GNU Lesser General Public License Version 2.1 ##
## # (see LICENSE file for the text of the license) ##
##########################################################################
# Makefile for the Coq documentation
# Read doc/README.md to learn about the dependencies
# The main entry point :
documentation: doc-$(WITHDOC) ## see $(WITHDOC) in config/Makefile
doc-all: doc
doc-no:
.PHONY: documentation doc-all doc-no
######################################################################
### Variables
######################################################################
LATEX:=latex
MAKEINDEX:=makeindex
PDFLATEX:=pdflatex
DVIPS:=dvips
HTMLSTYLE:=coqremote
# Sphinx-related variables
OSNAME:=$(shell uname -s)
ifeq ($(findstring CYGWIN,$(OSNAME)),CYGWIN)
WIN_CURDIR:=$(shell cygpath -m $(CURDIR))
SPHINXENV:=OCAMLPATH="$(CURDIR);$(OCAMLPATH)" COQBIN="$(CURDIR)/bin/" COQLIB="$(WIN_CURDIR)"
else
SPHINXENV:=OCAMLPATH="$(CURDIR):$(OCAMLPATH)" COQBIN="$(CURDIR)/$(CBIN)" COQLIB="$(CURDIR)/$(VO_OUT_DIR)"
endif
SPHINXWARNERROR ?= 1
ifeq ($(SPHINXWARNERROR),1)
SPHINXOPTS= -W
else
SPHINXOPTS=
endif
SPHINXBUILD= sphinx-build
SPHINXBUILDDIR= doc/sphinx/_build
# Internal variables.
ALLSPHINXOPTS= -d $(SPHINXBUILDDIR)/doctrees $(SPHINXOPTS)
# Output directory setup
ifdef INSIDE_DUNE
ROOT_DOC_BUILD_DIR=_build
else
ROOT_DOC_BUILD_DIR=_build_vo
endif
DOC_BUILD_DIR=$(ROOT_DOC_BUILD_DIR)/default/doc
DOC_STDLIB_DIR=$(DOC_BUILD_DIR)/stdlib/
DOC_STDLIB_HTML_DIR=$(DOC_BUILD_DIR)/stdlib/html/
DOC_COMMON_DIR=$(DOC_BUILD_DIR)/common
######################################################################
### General rules
######################################################################
.PHONY: doc doc-html doc-pdf doc-ps
.PHONY: doc-stdlib doc-stdlib-html full-stdlib sphinx
doc: refman doc-stdlib
SPHINX_DEPS ?=
ifndef QUICK
SPHINX_DEPS := coq
endif
# refman-html and refman-latex
refman-%: $(SPHINX_DEPS) $(DOC_BUILD_DIR)/unreleased.rst
$(SHOW)'SPHINXBUILD doc/sphinx ($*)'
$(HIDE)cp -a $(DOC_BUILD_DIR)/unreleased.rst doc # to fix when we move the sphinx build out-of-tree
$(HIDE)$(SPHINXENV) $(SPHINXBUILD) -b $* \
$(ALLSPHINXOPTS) doc/sphinx $(SPHINXBUILDDIR)/$*
COQREFMAN_FILES := $(wildcard $(SPHINXBUILDDIR)/latex/CoqRefMan*)
LATEX_REMOVE_FILES := $(filter-out $(SPHINXBUILDDIR)/latex/CoqRefMan.tex, $(COQREFMAN_FILES))
refman-pdf: refman-latex
rm -f $(LATEX_REMOVE_FILES)
+$(MAKE) -C $(SPHINXBUILDDIR)/latex LATEXMKOPTS=-silent
refman: $(SPHINX_DEPS)
+$(MAKE) refman-html
+$(MAKE) refman-pdf
# compatibility alias
sphinx: refman-html
DOCCOMMON:=$(DOC_COMMON_DIR)/version.tex $(DOC_COMMON_DIR)/title.tex $(DOC_COMMON_DIR)/macros.tex
$(DOC_COMMON_DIR)/%.tex: doc/common/%.tex
$(HIDE)mkdir -p $(DOC_COMMON_DIR)
$(HIDE)cp -a $< $@
doc-html:\
$(DOC_STDLIB_HTML_DIR)/index.html refman-html
doc-pdf:\
$(DOC_STDLIB_DIR)/Library.pdf refman-pdf
doc-ps:\
$(DOC_STDLIB_DIR)/Library.ps
doc-stdlib-html: $(DOC_STDLIB_HTML_DIR)/index.html
doc-stdlib: \
$(DOC_STDLIB_HTML_DIR)/index.html $(DOC_STDLIB_DIR)/Library.ps $(DOC_STDLIB_DIR)/Library.pdf
full-stdlib: \
$(DOC_STDLIB_HTML_DIR)/index.html $(DOC_STDLIB_DIR)/FullLibrary.ps $(DOC_STDLIB_DIR)/FullLibrary.pdf
sphinx-clean:
rm -rf $(SPHINXBUILDDIR) doc/sphinx/index.rst doc/sphinx/zebibliography.rst
# We now require a install layout to be available.
.PHONY: plugin-tutorial
plugin-tutorial: states $(BCONTEXT)/coq-core.install | $(VO_OUT_DIR)
mkdir -p $(VO_OUT_DIR)/tools/
cp tools/CoqMakefile.in $(VO_OUT_DIR)/tools/
+$(MAKE) OCAMLPATH=$(shell pwd)/$(CONTEXT)/lib/ COQBIN=$(shell pwd)/$(CBIN)/ COQCORELIB=$(shell pwd)/$(CONTEXT)/lib/coq-core COQLIB=$(shell pwd)/$(VO_OUT_DIR) -C $(PLUGINTUTO)
######################################################################
### Implicit rules
######################################################################
%.ps: %.dvi
(cd `dirname $<`; $(DVIPS) -q -o `basename $@` `basename $<`)
######################################################################
# Common
######################################################################
### Version
doc/common/version.tex: config/Makefile
printf '\\newcommand{\\coqversion}{$(VERSION)}' > doc/common/version.tex
### Changelog
$(DOC_BUILD_DIR)/unreleased.rst: $(wildcard doc/changelog/00-title.rst doc/changelog/*/*.rst)
$(SHOW)'AGGREGATE $@'
$(HIDE)mkdir -p $(DOC_BUILD_DIR)
$(HIDE)cat doc/changelog/00-title.rst doc/changelog/*/*.rst > $@
######################################################################
# Standard library
######################################################################
DOCLIBS=-R $(VO_OUT_DIR)theories Coq -Q $(VO_OUT_DIR)user-contrib/Ltac2 Ltac2
### Standard library (browsable html format)
ifdef QUICK
$(DOC_STDLIB_HTML_DIR)/genindex.html:
else
$(DOC_STDLIB_HTML_DIR)/genindex.html: | $(COQDOC) $(COQDOCCSS) $(ALLVO)
endif
- rm -rf $(DOC_STDLIB_HTML_DIR)
$(MKDIR) -p $(DOC_STDLIB_HTML_DIR)
$(SHOW)'COQDOC VFILES'
$(HIDE)export COQLIB=$(CONTEXT)/lib/coq-core && $(COQDOC) -q -d $(DOC_STDLIB_HTML_DIR) --with-header doc/common/styles/html/$(HTMLSTYLE)/header.html --with-footer doc/common/styles/html/$(HTMLSTYLE)/footer.html --multi-index --html -g \
$(DOCLIBS) $(BUILD_VFILES)
mv $(DOC_STDLIB_HTML_DIR)/index.html $(DOC_STDLIB_HTML_DIR)/genindex.html
$(DOC_STDLIB_DIR)/index-list.html.template: doc/stdlib/index-list.html.template
$(HIDE)mkdir -p $(DOC_STDLIB_DIR)
$(HIDE)cp -a $< $@
$(DOC_STDLIB_DIR)/index-list.html: $(DOC_STDLIB_DIR)/index-list.html.template doc/stdlib/make-library-index
./doc/stdlib/make-library-index $(DOC_STDLIB_DIR)/index-list.html doc/stdlib/hidden-files
$(DOC_STDLIB_HTML_DIR)/index.html: $(DOC_STDLIB_HTML_DIR)/genindex.html $(DOC_STDLIB_DIR)/index-list.html
$(MKDIR) -p $(DOC_STDLIB_HTML_DIR)
cat doc/common/styles/html/$(HTMLSTYLE)/header.html $(DOC_STDLIB_DIR)/index-list.html > $@
cat doc/common/styles/html/$(HTMLSTYLE)/footer.html >> $@
### Standard library (light version, full version is definitely too big)
ifdef QUICK
$(DOC_STDLIB_DIR)/Library.coqdoc.tex:
else
$(DOC_STDLIB_DIR)/Library.coqdoc.tex: | $(COQDOC) $(COQDOCSTY) $(THEORIESLIGHTVO)
endif
export COQLIB=$(CONTEXT)/lib/coq-core && $(COQDOC) -q --gallina --body-only --latex --stdout \
-R $(VO_OUT_DIR)theories Coq $(THEORIESLIGHTVO:.$(VO)=.v) >> $@
SHOW_LATEX_MESSAGES:=$(shell pwd)/doc/tools/show_latex_messages
$(DOC_STDLIB_DIR)/Library.dvi: $(DOCCOMMON) $(DOC_STDLIB_DIR)/Library.coqdoc.tex $(DOC_STDLIB_DIR)/Library.tex
(cd $(DOC_STDLIB_DIR);\
$(LATEX) -interaction=batchmode Library;\
$(LATEX) -interaction=batchmode Library > /dev/null;\
$(SHOW_LATEX_MESSAGES) -no-overfull Library.log)
$(DOC_STDLIB_DIR)/Library.pdf: $(DOCCOMMON) $(DOC_STDLIB_DIR)/Library.coqdoc.tex $(DOC_STDLIB_DIR)/Library.dvi
(cd $(DOC_STDLIB_DIR);\
$(PDFLATEX) -interaction=batchmode Library;\
$(SHOW_LATEX_MESSAGES) -no-overfull Library.log)
$(DOC_STDLIB_DIR)/Library.tex: doc/stdlib/Library.tex
$(HIDE)cp -a $< $@
### Standard library (full version if you're crazy enough to try)
$(DOC_STDLIB_DIR)/FullLibrary.tex: $(DOC_STDLIB_DIR)/Library.tex
sed -e 's/Library.coqdoc/FullLibrary.coqdoc/g;s/\\begin{document}/\\newcommand{\\textlambda}{\\ensuremath{\\lambda}}\\newcommand{\\textPi}{\\ensuremath{\\Pi}}\\begin{document}/' $< > $@
ifdef QUICK
$(DOC_STDLIB_DIR)/FullLibrary.coqdoc.tex:
export COQLIB=$(CONTEXT)/lib/coq-core && $(COQDOC) -q --gallina --body-only --latex --stdout --utf8 \
$(DOCLIBS) $(BUILD_VFILES) > $@
sed -i.tmp -e 's///g' $@ && rm $@.tmp
else
$(DOC_STDLIB_DIR)/FullLibrary.coqdoc.tex: $(COQDOC) $(COQDOCSTY) $(ALLVO)
export COQLIB=$(CONTEXT)/lib/coq-core && $(COQDOC) -q --gallina --body-only --latex --stdout --utf8 \
$(DOCLIBS) $(BUILD_VFILES) > $@
sed -i.tmp -e 's///g' $@ && rm $@.tmp
endif
$(DOC_STDLIB_DIR)/FullLibrary.dvi: $(DOCCOMMON) $(DOC_STDLIB_DIR)/FullLibrary.coqdoc.tex $(DOC_STDLIB_DIR)/FullLibrary.tex
(cd $(DOC_STDLIB_DIR);\
$(LATEX) -interaction=batchmode FullLibrary;\
$(LATEX) -interaction=batchmode FullLibrary > /dev/null;\
$(SHOW_LATEX_MESSAGES) -no-overfull FullLibrary.log)
$(DOC_STDLIB_DIR)/FullLibrary.pdf: $(DOCCOMMON) $(DOC_STDLIB_DIR)/FullLibrary.coqdoc.tex $(DOC_STDLIB_DIR)/FullLibrary.dvi
(cd $(DOC_STDLIB_DIR);\
$(PDFLATEX) -interaction=batchmode FullLibrary;\
$(SHOW_LATEX_MESSAGES) -no-overfull FullLibrary.log)
######################################################################
# Install all documentation files
######################################################################
.PHONY: install-doc install-doc-meta install-doc-html install-doc-printable \
install-doc-sphinx install-doc-stdlib-html
# Due to Windows paths not starting with / we can't just set the
# default to / and always use --destdir
ifeq ($(DESTDIR),)
DOCDIRDEST=$(DOCDIR)/coq
else
DOCDIRDEST=$(DESTDIR)/$(DOCDIR)/coq
endif
install-doc: install-doc-meta install-doc-html install-doc-printable
install-doc-meta:
$(MKDIR) $(DOCDIRDEST)
$(INSTALLLIB) doc/LICENSE $(DOCDIRDEST)/LICENSE.doc
install-doc-html: install-doc-stdlib-html install-doc-sphinx
install-doc-stdlib-html:
$(MKDIR) $(DOCDIRDEST)/html/stdlib
$(INSTALLLIB) $(DOC_STDLIB_HTML_DIR)/* $(DOCDIRDEST)/html/stdlib
install-doc-printable:
$(MKDIR) $(DOCDIRDEST)/ps $(DOCDIRDEST)/pdf
$(INSTALLLIB) $(DOC_STDLIB_DIR)/Library.pdf $(DOCDIRDEST)/pdf
$(INSTALLLIB) $(DOC_STDLIB_DIR)/Library.ps $(DOCDIRDEST)/ps
install-doc-sphinx:
$(MKDIR) $(DOCDIRDEST)/sphinx
(for d in html latex; do \
for f in `cd doc/sphinx/_build/$$d && find . -type f`; do \
$(MKDIR) $$(dirname $(DOCDIRDEST)/sphinx/$$d/$$f);\
$(INSTALLLIB) doc/sphinx/_build/$$d/$$f $(DOCDIRDEST)/sphinx/$$d/$$f;\
done; done)
include Makefile.docgram
# For emacs:
# Local Variables:
# mode: makefile
# End:
|
