1 # -*- makefile-gmake -*-
5 # You can set these variables from the command line.
7 SPHINXBUILD = env LD_LIBRARY_PATH=${NOTMUCH_BUILDDIR}/lib sphinx-build
8 DOCBUILDDIR := $(dir)/_build
11 ALLSPHINXOPTS := $(SPHINXOPTS) $(srcdir)/$(dir)
12 APIMAN := $(DOCBUILDDIR)/man/man3/notmuch.3
13 DOXYFILE := $(srcdir)/$(dir)/doxygen.cfg
15 MAN1_RST := $(wildcard $(srcdir)/doc/man1/*.rst)
16 MAN5_RST := $(wildcard $(srcdir)/doc/man5/*.rst)
17 MAN7_RST := $(wildcard $(srcdir)/doc/man7/*.rst)
18 MAN_RST_FILES := $(MAN1_RST) $(MAN5_RST) $(MAN7_RST)
19 ALL_RST_FILES := $(MAN_RST_FILES) $(srcdir)/doc/notmuch-emacs.rst
21 MAN1_ROFF := $(patsubst $(srcdir)/doc/%,$(DOCBUILDDIR)/man/%,$(MAN1_RST:.rst=.1))
22 MAN5_ROFF := $(patsubst $(srcdir)/doc/%,$(DOCBUILDDIR)/man/%,$(MAN5_RST:.rst=.5))
23 MAN7_ROFF := $(patsubst $(srcdir)/doc/%,$(DOCBUILDDIR)/man/%,$(MAN7_RST:.rst=.7))
24 MAN_ROFF_FILES := $(MAN1_ROFF) $(MAN5_ROFF) $(MAN7_ROFF)
26 MAN_GZIP_FILES := $(addsuffix .gz,${MAN_ROFF_FILES})
28 MAN1_TEXI := $(patsubst $(srcdir)/doc/man1/%.rst,$(DOCBUILDDIR)/texinfo/%.texi,$(MAN1_RST))
29 MAN5_TEXI := $(patsubst $(srcdir)/doc/man5/%.rst,$(DOCBUILDDIR)/texinfo/%.texi,$(MAN5_RST))
30 MAN7_TEXI := $(patsubst $(srcdir)/doc/man7/%.rst,$(DOCBUILDDIR)/texinfo/%.texi,$(MAN7_RST))
31 INFO_TEXI_FILES := $(MAN1_TEXI) $(MAN5_TEXI) $(MAN7_TEXI)
32 ifeq ($(WITH_EMACS),1)
33 INFO_TEXI_FILES += $(DOCBUILDDIR)/texinfo/notmuch-emacs.texi
36 INFO_INFO_FILES := $(INFO_TEXI_FILES:.texi=.info)
38 .PHONY: sphinx-html sphinx-texinfo sphinx-info
40 .PHONY: install-man build-man apidocs install-apidocs
43 rm -f $@ && gzip --no-name --stdout $^ > $@
45 ifeq ($(WITH_EMACS),1)
46 $(DOCBUILDDIR)/.roff.stamp $(DOCBUILDDIR)/.html.stamp $(DOCBUILDDIR)/.texi.stamp : docstring.stamp
49 ifeq ($(HAVE_PYTHON3_CFFI),1)
50 DOC_PREREQS=bindings/python-cffi.stamp
55 sphinx-html: $(DOCBUILDDIR)/.html.stamp
57 $(DOCBUILDDIR)/.html.stamp: $(ALL_RST_FILES) $(DOC_PREREQS)
58 $(SPHINXBUILD) -b html -d $(DOCBUILDDIR)/html_doctrees $(ALLSPHINXOPTS) $(DOCBUILDDIR)/html
61 sphinx-texinfo: $(DOCBUILDDIR)/.texi.stamp
63 $(DOCBUILDDIR)/.texi.stamp: $(ALL_RST_FILES) $(DOC_PREREQS)
64 $(SPHINXBUILD) -b texinfo -d $(DOCBUILDDIR)/texinfo_doctrees $(ALLSPHINXOPTS) $(DOCBUILDDIR)/texinfo
67 sphinx-info: $(DOCBUILDDIR)/.info.stamp
69 $(DOCBUILDDIR)/.info.stamp: $(DOCBUILDDIR)/.texi.stamp $(DOC_PREREQS)
70 $(MAKE) -C $(DOCBUILDDIR)/texinfo info
73 # Use the man page converter that is available. We should never depend
74 # on MAN_ROFF_FILES if a converter is not available.
75 ${MAN_ROFF_FILES}: $(DOCBUILDDIR)/.roff.stamp
77 # By using $(DOCBUILDDIR)/.roff.stamp instead of ${MAN_ROFF_FILES}, we
78 # convey to make that a single invocation of this recipe builds all
79 # of the roff files. This prevents parallel make from starting an
80 # instance of this recipe for each roff file.
81 $(DOCBUILDDIR)/.roff.stamp: ${MAN_RST_FILES}
82 ifeq ($(HAVE_SPHINX),1)
83 $(SPHINXBUILD) -b man -d $(DOCBUILDDIR)/man_doctrees $(ALLSPHINXOPTS) $(DOCBUILDDIR)/man
84 for section in 1 5 7; do \
85 mkdir -p $(DOCBUILDDIR)/man/man$${section}; \
86 mv $(DOCBUILDDIR)/man/*.$${section} $(DOCBUILDDIR)/man/man$${section}; \
89 @echo "Fatal: build dependency fail."
94 install-man: install-apidocs
96 ifeq ($(HAVE_DOXYGEN),1)
97 MAN_GZIP_FILES += ${APIMAN}.gz
99 install-apidocs: ${APIMAN}.gz
100 mkdir -p "$(DESTDIR)$(mandir)/man3"
101 install -m0644 $(filter %.3.gz,$(MAN_GZIP_FILES)) $(DESTDIR)/$(mandir)/man3
103 $(APIMAN): $(dir)/config.dox $(srcdir)/$(dir)/doxygen.cfg $(srcdir)/lib/notmuch.h
104 mkdir -p $(DOCBUILDDIR)/man/man3
106 rm -f $(DOCBUILDDIR)/man/man3/_*.3
107 perl -pi -e 's/^[.]RI "\\fI/.RI "\\fP/' $(APIMAN)
113 # Do not try to build or install man pages if a man page converter is
115 ifeq ($(HAVE_SPHINX),0)
118 @echo "No sphinx, will not install man pages."
121 # it should be safe to depend on the stamp file, because it is created
122 # after all roff files are moved into place.
123 ${MAN_GZIP_FILES}: ${DOCBUILDDIR}/.roff.stamp
125 build-man: ${MAN_GZIP_FILES}
126 install-man: ${MAN_GZIP_FILES}
127 mkdir -m0755 -p "$(DESTDIR)$(mandir)/man1"
128 mkdir -m0755 -p "$(DESTDIR)$(mandir)/man5"
129 mkdir -m0755 -p "$(DESTDIR)$(mandir)/man7"
130 install -m0644 $(filter %.1.gz,$(MAN_GZIP_FILES)) $(DESTDIR)/$(mandir)/man1
131 install -m0644 $(filter %.5.gz,$(MAN_GZIP_FILES)) $(DESTDIR)/$(mandir)/man5
132 install -m0644 $(filter %.7.gz,$(MAN_GZIP_FILES)) $(DESTDIR)/$(mandir)/man7
133 cd $(DESTDIR)/$(mandir)/man1 && ln -sf notmuch.1.gz notmuch-setup.1.gz
136 ifneq ($(HAVE_SPHINX)$(HAVE_MAKEINFO),11)
138 @echo "Missing sphinx or makeinfo, not building info pages"
140 build-info: $(DOCBUILDDIR)/.info.stamp
143 ifneq ($(HAVE_SPHINX)$(HAVE_MAKEINFO)$(HAVE_INSTALL_INFO),111)
145 @echo "Missing prerequisites, not installing info pages"
147 install-info: build-info
148 mkdir -m0755 -p "$(DESTDIR)$(infodir)"
149 install -m0644 $(INFO_INFO_FILES) $(DESTDIR)$(infodir)
150 for file in $(INFO_INFO_FILES); do install-info $$file $(DESTDIR)$(infodir)/dir; done
153 $(dir)/config.dox: version.stamp
154 echo "PROJECT_NAME = \"Notmuch $(VERSION)\"" > $@
155 echo "INPUT=${srcdir}/lib/notmuch.h" >> $@
157 CLEAN := $(CLEAN) $(DOCBUILDDIR) $(DOCBUILDDIR)/.roff.stamp $(DOCBUILDDIR)/.texi.stamp
158 CLEAN := $(CLEAN) $(DOCBUILDDIR)/.html.stamp $(DOCBUILDDIR)/.info.stamp
159 CLEAN := $(CLEAN) $(MAN_GZIP_FILES) $(MAN_ROFF_FILES) $(dir)/conf.pyc $(dir)/config.dox