test: drop use of db_ending
[notmuch] / doc / Makefile.local
1 # -*- makefile -*-
2
3 dir := doc
4
5 # You can set these variables from the command line.
6 SPHINXOPTS    := -q
7 SPHINXBUILD   = WITH_EMACS=${WITH_EMACS} sphinx-build
8 DOCBUILDDIR      := $(dir)/_build
9
10 # Internal variables.
11 ALLSPHINXOPTS   := $(SPHINXOPTS) $(srcdir)/$(dir)
12 APIMAN          := $(DOCBUILDDIR)/man/man3/notmuch.3
13 DOXYFILE        := $(srcdir)/$(dir)/doxygen.cfg
14
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
20
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)
25
26 MAN_GZIP_FILES := $(addsuffix .gz,${MAN_ROFF_FILES})
27
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
34 endif
35
36 INFO_INFO_FILES := $(INFO_TEXI_FILES:.texi=.info)
37
38 .PHONY: sphinx-html sphinx-texinfo sphinx-info
39
40 .PHONY: install-man build-man apidocs install-apidocs
41
42 %.gz: %
43         rm -f $@ && gzip --stdout $^ > $@
44
45 ifeq ($(WITH_EMACS),1)
46 $(DOCBUILDDIR)/.roff.stamp sphinx-html sphinx-texinfo: docstring.stamp
47 endif
48
49 sphinx-html: $(DOCBUILDDIR)/.html.stamp
50
51 $(DOCBUILDDIR)/.html.stamp: $(ALL_RST_FILES)
52         $(SPHINXBUILD) -b html -d $(DOCBUILDDIR)/html_doctrees $(ALLSPHINXOPTS) $(DOCBUILDDIR)/html
53         touch $@
54
55 sphinx-texinfo: $(DOCBUILDDIR)/.texi.stamp
56
57 $(DOCBUILDDIR)/.texi.stamp: $(ALL_RST_FILES)
58         $(SPHINXBUILD) -b texinfo -d $(DOCBUILDDIR)/texinfo_doctrees $(ALLSPHINXOPTS) $(DOCBUILDDIR)/texinfo
59         touch $@
60
61 sphinx-info: sphinx-texinfo
62         $(MAKE) -C $(DOCBUILDDIR)/texinfo info
63
64 # Use the man page converter that is available. We should never depend
65 # on MAN_ROFF_FILES if a converter is not available.
66 ${MAN_ROFF_FILES}: $(DOCBUILDDIR)/.roff.stamp
67
68 # By using $(DOCBUILDDIR)/.roff.stamp instead of ${MAN_ROFF_FILES}, we
69 # convey to make that a single invocation of this recipe builds all
70 # of the roff files.  This prevents parallel make from starting an
71 # instance of this recipe for each roff file.
72 $(DOCBUILDDIR)/.roff.stamp: ${MAN_RST_FILES}
73 ifeq ($(HAVE_SPHINX),1)
74         $(SPHINXBUILD) -b man -d $(DOCBUILDDIR)/man_doctrees $(ALLSPHINXOPTS) $(DOCBUILDDIR)/man
75         for section in 1 5 7; do \
76             mkdir -p $(DOCBUILDDIR)/man/man$${section}; \
77             mv $(DOCBUILDDIR)/man/*.$${section} $(DOCBUILDDIR)/man/man$${section}; \
78         done
79 else
80         @echo "Fatal: build dependency fail."
81         @false
82 endif
83         touch $@
84
85 install-man: install-apidocs
86
87 ifeq ($(HAVE_DOXYGEN),1)
88 MAN_GZIP_FILES += ${APIMAN}.gz
89 apidocs: $(APIMAN)
90 install-apidocs: ${APIMAN}.gz
91         mkdir -p "$(DESTDIR)$(mandir)/man3"
92         install -m0644 $(filter %.3.gz,$(MAN_GZIP_FILES)) $(DESTDIR)/$(mandir)/man3
93
94 $(APIMAN): $(dir)/config.dox $(srcdir)/$(dir)/doxygen.cfg $(srcdir)/lib/notmuch.h
95         mkdir -p $(DOCBUILDDIR)/man/man3
96         doxygen $(DOXYFILE)
97         rm -f $(DOCBUILDDIR)/man/man3/_*.3
98         perl -pi -e 's/^[.]RI "\\fI/.RI "\\fP/' $(APIMAN)
99 else
100 apidocs:
101 install-apidocs:
102 endif
103
104 # Do not try to build or install man pages if a man page converter is
105 # not available.
106 ifeq ($(HAVE_SPHINX),0)
107 build-man:
108 install-man:
109         @echo "No sphinx, will not install man pages."
110 else
111 build-man: ${MAN_GZIP_FILES}
112 install-man: ${MAN_GZIP_FILES}
113         mkdir -m0755 -p "$(DESTDIR)$(mandir)/man1"
114         mkdir -m0755 -p "$(DESTDIR)$(mandir)/man5"
115         mkdir -m0755 -p "$(DESTDIR)$(mandir)/man7"
116         install -m0644 $(filter %.1.gz,$(MAN_GZIP_FILES)) $(DESTDIR)/$(mandir)/man1
117         install -m0644 $(filter %.5.gz,$(MAN_GZIP_FILES)) $(DESTDIR)/$(mandir)/man5
118         install -m0644 $(filter %.7.gz,$(MAN_GZIP_FILES)) $(DESTDIR)/$(mandir)/man7
119         cd $(DESTDIR)/$(mandir)/man1 && ln -sf notmuch.1.gz notmuch-setup.1.gz
120 endif
121
122 ifneq ($(HAVE_SPHINX)$(HAVE_MAKEINFO),11)
123 build-info:
124         @echo "Missing sphinx or makeinfo, not building info pages"
125 else
126 build-info: sphinx-info
127 endif
128
129 ifneq ($(HAVE_SPHINX)$(HAVE_MAKEINFO)$(HAVE_INSTALL_INFO),111)
130 install-info:
131         @echo "Missing prerequisites, not installing info pages"
132 else
133 install-info: build-info
134         mkdir -m0755 -p "$(DESTDIR)$(infodir)"
135         install -m0644 $(INFO_INFO_FILES) $(DESTDIR)$(infodir)
136         for file in $(INFO_INFO_FILES); do install-info $$file $(DESTDIR)$(infodir)/dir; done
137 endif
138
139 $(dir)/config.dox: version.stamp
140         echo "PROJECT_NAME = \"Notmuch $(VERSION)\"" > $@
141         echo "INPUT=${srcdir}/lib/notmuch.h" >> $@
142
143 CLEAN := $(CLEAN) $(DOCBUILDDIR) $(DOCBUILDDIR)/.roff.stamp $(DOCBUILDDIR)/.texi.stamp
144 CLEAN := $(CLEAN) $(DOCBUILDDIR)/.html.stamp
145 CLEAN := $(CLEAN) $(MAN_GZIP_FILES) $(MAN_ROFF_FILES) $(dir)/conf.pyc $(dir)/config.dox