5 # You can set these variables from the command line.
7 SPHINXBUILD = sphinx-build
8 DOCBUILDDIR := $(dir)/_build
10 mkdocdeps := $(PYTHON) $(srcdir)/$(dir)/mkdocdeps.py
13 ALLSPHINXOPTS := -d $(DOCBUILDDIR)/doctrees $(SPHINXOPTS) $(srcdir)/$(dir)
14 APIMAN := $(DOCBUILDDIR)/man/man3/notmuch.3
15 DOXYFILE := $(srcdir)/$(dir)/doxygen.cfg
17 .PHONY: sphinx-html sphinx-texinfo sphinx-info
19 .PHONY: install-man build-man apidocs install-apidocs
22 rm -f $@ && gzip --stdout $^ > $@
25 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(DOCBUILDDIR)/html
28 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(DOCBUILDDIR)/texinfo
30 sphinx-info: sphinx-texinfo
31 make -C $(DOCBUILDDIR)/texinfo info
33 -include $(dir)/docdeps.mk
35 MAN_GZIP_FILES := $(addsuffix .gz,${MAN_ROFF_FILES})
37 # Use the man page converter that is available. We should never depend
38 # on MAN_ROFF_FILES if a converter is not available.
39 ${MAN_ROFF_FILES}: $(DOCBUILDDIR)/.roff.stamp
41 # By using $(DOCBUILDDIR)/.roff.stamp instead of ${MAN_ROFF_FILES}, we
42 # convey to make that a single invocation of this recipe builds all
43 # of the roff files. This prevents parallel make from starting an
44 # instance of this recipe for each roff file.
45 $(DOCBUILDDIR)/.roff.stamp: ${MAN_RST_FILES}
46 ifeq ($(HAVE_SPHINX),1)
47 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(DOCBUILDDIR)/man
48 for section in 1 5 7; do \
49 mkdir -p $(DOCBUILDDIR)/man/man$${section}; \
50 mv $(DOCBUILDDIR)/man/*.$${section} $(DOCBUILDDIR)/man/man$${section}; \
53 @echo "Fatal: build dependency fail."
56 touch ${MAN_ROFF_FILES} $@
58 install-man: install-apidocs
60 ifeq ($(HAVE_DOXYGEN),1)
61 MAN_GZIP_FILES += ${APIMAN}.gz
63 install-apidocs: ${APIMAN}.gz
64 mkdir -p "$(DESTDIR)$(mandir)/man3"
65 install -m0644 $(DOCBUILDDIR)/man/man3/*.3.gz $(DESTDIR)/$(mandir)/man3
67 $(APIMAN): $(dir)/config.dox $(srcdir)/$(dir)/doxygen.cfg $(srcdir)/lib/notmuch.h
68 mkdir -p $(DOCBUILDDIR)/man/man3
70 rm -f $(DOCBUILDDIR)/man/man3/_*.3
71 perl -pi -e 's/^[.]RI "\\fI/.RI "\\fP/' $(APIMAN)
77 # Do not try to build or install man pages if a man page converter is
79 ifeq ($(HAVE_SPHINX),0)
82 @echo "No sphinx, will not install man pages."
84 build-man: ${MAN_GZIP_FILES}
85 install-man: ${MAN_GZIP_FILES}
86 mkdir -p "$(DESTDIR)$(mandir)/man1"
87 mkdir -p "$(DESTDIR)$(mandir)/man5"
88 mkdir -p "$(DESTDIR)$(mandir)/man7"
89 install -m0644 $(DOCBUILDDIR)/man/man1/*.1.gz $(DESTDIR)/$(mandir)/man1
90 install -m0644 $(DOCBUILDDIR)/man/man5/*.5.gz $(DESTDIR)/$(mandir)/man5
91 install -m0644 $(DOCBUILDDIR)/man/man7/*.7.gz $(DESTDIR)/$(mandir)/man7
92 cd $(DESTDIR)/$(mandir)/man1 && ln -sf notmuch.1.gz notmuch-setup.1.gz
95 $(dir)/config.dox: version.stamp
96 echo "PROJECT_NAME = \"Notmuch $(VERSION)\"" > $@
97 echo "INPUT=${srcdir}/lib/notmuch.h" >> $@
99 $(dir)/docdeps.mk: $(dir)/conf.py $(dir)/mkdocdeps.py
100 $(mkdocdeps) $(srcdir)/doc $(DOCBUILDDIR) $@
102 CLEAN := $(CLEAN) $(DOCBUILDDIR) $(dir)/docdeps.mk $(DOCBUILDDIR)/.roff.stamp
103 CLEAN := $(CLEAN) $(MAN_GZIP_FILES) $(MAN_ROFF_FILES) $(dir)/conf.pyc $(dir)/config.dox