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)
16 .PHONY: sphinx-html sphinx-texinfo sphinx-info
18 .PHONY: install-man build-man
21 rm -f $@ && gzip --stdout $^ > $@
24 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(DOCBUILDDIR)/html
27 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(DOCBUILDDIR)/texinfo
29 sphinx-info: sphinx-texinfo
30 make -C $(DOCBUILDDIR)/texinfo info
32 -include $(dir)/docdeps.mk
34 MAN_GZIP_FILES := $(addsuffix .gz,${MAN_ROFF_FILES})
36 # Use the man page converter that is available. We should never depend
37 # on MAN_ROFF_FILES if a converter is not available.
38 ${MAN_ROFF_FILES}: $(DOCBUILDDIR)/.roff.stamp
40 # By using $(DOCBUILDDIR)/.roff.stamp instead of ${MAN_ROFF_FILES}, we
41 # convey to make that a single invocation of this recipe builds all
42 # of the roff files. This prevents parallel make from starting an
43 # instance of this recipe for each roff file.
44 $(DOCBUILDDIR)/.roff.stamp: ${MAN_RST_FILES}
45 ifeq ($(HAVE_SPHINX),1)
46 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(DOCBUILDDIR)/man
47 for section in 1 5 7; do \
48 mkdir -p $(DOCBUILDDIR)/man/man$${section}; \
49 mv $(DOCBUILDDIR)/man/*.$${section} $(DOCBUILDDIR)/man/man$${section}; \
51 else ifeq ($(HAVE_RST2MAN),1)
52 $(prerst2man) $(srcdir)/doc $(DOCBUILDDIR)/man
54 @echo "Fatal: build dependency fail."
57 touch ${MAN_ROFF_FILES} $@
59 # Do not try to build or install man pages if a man page converter is
61 ifeq ($(HAVE_SPHINX)$(HAVE_RST2MAN),00)
64 @echo "No sphinx or rst2man, will not install man pages."
66 build-man: ${MAN_GZIP_FILES}
67 install-man: ${MAN_GZIP_FILES}
68 mkdir -p "$(DESTDIR)$(mandir)/man1"
69 mkdir -p "$(DESTDIR)$(mandir)/man5"
70 mkdir -p "$(DESTDIR)$(mandir)/man7"
71 install -m0644 $(DOCBUILDDIR)/man/man1/*.1.gz $(DESTDIR)/$(mandir)/man1
72 install -m0644 $(DOCBUILDDIR)/man/man5/*.5.gz $(DESTDIR)/$(mandir)/man5
73 install -m0644 $(DOCBUILDDIR)/man/man7/*.7.gz $(DESTDIR)/$(mandir)/man7
74 cd $(DESTDIR)/$(mandir)/man1 && ln -sf notmuch.1.gz notmuch-setup.1.gz
77 $(dir)/docdeps.mk: $(dir)/conf.py $(dir)/mkdocdeps.py
78 $(mkdocdeps) $(srcdir)/doc $(DOCBUILDDIR) $@
80 CLEAN := $(CLEAN) $(DOCBUILDDIR) $(dir)/docdeps.mk $(DOCBUILDDIR)/.roff.stamp
81 CLEAN := $(CLEAN) $(MAN_GZIP_FILES) $(MAN_ROFF_FILES)