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