git.notmuchmail.org Git - notmuch/blob - 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   = sphinx-build
   8 DOCBUILDDIR      := $(dir)/_build
   9
  10 # Internal variables.
  11 ALLSPHINXOPTS   := -d $(DOCBUILDDIR)/doctrees $(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
  20 MAN1_ROFF := $(patsubst $(srcdir)/doc/%,$(DOCBUILDDIR)/man/%,$(MAN1_RST:.rst=.1))
  21 MAN5_ROFF := $(patsubst $(srcdir)/doc/%,$(DOCBUILDDIR)/man/%,$(MAN5_RST:.rst=.5))
  22 MAN7_ROFF := $(patsubst $(srcdir)/doc/%,$(DOCBUILDDIR)/man/%,$(MAN7_RST:.rst=.7))
  23 MAN_ROFF_FILES := $(MAN1_ROFF) $(MAN5_ROFF) $(MAN7_ROFF)
  24
  25 MAN_GZIP_FILES := $(addsuffix .gz,${MAN_ROFF_FILES})
  26
  27 MAN1_TEXI := $(patsubst $(srcdir)/doc/man1/%.rst,$(DOCBUILDDIR)/texinfo/%.texi,$(MAN1_RST))
  28 MAN5_TEXI := $(patsubst $(srcdir)/doc/man5/%.rst,$(DOCBUILDDIR)/texinfo/%.texi,$(MAN5_RST))
  29 MAN7_TEXI := $(patsubst $(srcdir)/doc/man7/%.rst,$(DOCBUILDDIR)/texinfo/%.texi,$(MAN7_RST))
  30 INFO_TEXI_FILES := $(MAN1_TEXI) $(MAN5_TEXI) $(MAN7_TEXI) $(DOCBUILDDIR)/texinfo/notmuch-emacs.texi
  31 INFO_INFO_FILES := $(INFO_TEXI_FILES:.texi=.info)
  32
  33 .PHONY: sphinx-html sphinx-texinfo sphinx-info
  34
  35 .PHONY: install-man build-man apidocs install-apidocs
  36
  37 %.gz: %
  38         rm -f $@ && gzip --stdout $^ > $@
  39
  40 # Sequentialize the calls to sphinx-build to avoid races with
  41 # reading/writing cached state. This uses GNU make specific
  42 # "order-only" prerequisites.
  43
  44 sphinx-html: | $(DOCBUILDDIR)/.roff.stamp
  45 sphinx-texinfo: | sphinx-html
  46 sphinx-info: | sphinx-texinfo
  47
  48 sphinx-html:
  49         $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(DOCBUILDDIR)/html
  50
  51 sphinx-texinfo:
  52         $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(DOCBUILDDIR)/texinfo
  53
  54 sphinx-info: sphinx-texinfo
  55         make -C $(DOCBUILDDIR)/texinfo info
  56
  57 # Use the man page converter that is available. We should never depend
  58 # on MAN_ROFF_FILES if a converter is not available.
  59 ${MAN_ROFF_FILES}: $(DOCBUILDDIR)/.roff.stamp
  60
  61 # By using $(DOCBUILDDIR)/.roff.stamp instead of ${MAN_ROFF_FILES}, we
  62 # convey to make that a single invocation of this recipe builds all
  63 # of the roff files.  This prevents parallel make from starting an
  64 # instance of this recipe for each roff file.
  65 $(DOCBUILDDIR)/.roff.stamp: ${MAN_RST_FILES}
  66 ifeq ($(HAVE_SPHINX),1)
  67         $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(DOCBUILDDIR)/man
  68         for section in 1 5 7; do \
  69             mkdir -p $(DOCBUILDDIR)/man/man$${section}; \
  70             mv $(DOCBUILDDIR)/man/*.$${section} $(DOCBUILDDIR)/man/man$${section}; \
  71         done
  72 else
  73         @echo "Fatal: build dependency fail."
  74         @false
  75 endif
  76         touch $@
  77
  78 install-man: install-apidocs
  79
  80 ifeq ($(HAVE_DOXYGEN),1)
  81 MAN_GZIP_FILES += ${APIMAN}.gz
  82 apidocs: $(APIMAN)
  83 install-apidocs: ${APIMAN}.gz
  84         mkdir -p "$(DESTDIR)$(mandir)/man3"
  85         install -m0644 $(filter %.3.gz,$(MAN_GZIP_FILES)) $(DESTDIR)/$(mandir)/man3
  86
  87 $(APIMAN): $(dir)/config.dox $(srcdir)/$(dir)/doxygen.cfg $(srcdir)/lib/notmuch.h
  88         mkdir -p $(DOCBUILDDIR)/man/man3
  89         doxygen $(DOXYFILE)
  90         rm -f $(DOCBUILDDIR)/man/man3/_*.3
  91         perl -pi -e 's/^[.]RI "\\fI/.RI "\\fP/' $(APIMAN)
  92 else
  93 apidocs:
  94 install-apidocs:
  95 endif
  96
  97 # Do not try to build or install man pages if a man page converter is
  98 # not available.
  99 ifeq ($(HAVE_SPHINX),0)
 100 build-man:
 101 install-man:
 102         @echo "No sphinx, will not install man pages."
 103 else
 104 build-man: ${MAN_GZIP_FILES}
 105 install-man: ${MAN_GZIP_FILES}
 106         mkdir -m0755 -p "$(DESTDIR)$(mandir)/man1"
 107         mkdir -m0755 -p "$(DESTDIR)$(mandir)/man5"
 108         mkdir -m0755 -p "$(DESTDIR)$(mandir)/man7"
 109         install -m0644 $(filter %.1.gz,$(MAN_GZIP_FILES)) $(DESTDIR)/$(mandir)/man1
 110         install -m0644 $(filter %.5.gz,$(MAN_GZIP_FILES)) $(DESTDIR)/$(mandir)/man5
 111         install -m0644 $(filter %.7.gz,$(MAN_GZIP_FILES)) $(DESTDIR)/$(mandir)/man7
 112         cd $(DESTDIR)/$(mandir)/man1 && ln -sf notmuch.1.gz notmuch-setup.1.gz
 113 endif
 114
 115 ifneq ($(HAVE_SPHINX)$(HAVE_MAKEINFO),11)
 116 build-info:
 117         @echo "Missing sphinx or makeinfo, not building info pages"
 118 else
 119 build-info: sphinx-info
 120 endif
 121
 122 ifneq ($(HAVE_SPHINX)$(HAVE_MAKEINFO)$(HAVE_INSTALL_INFO),111)
 123 install-info:
 124         @echo "Missing prerequisites, not installing info pages"
 125 else
 126 install-info: build-info
 127         mkdir -m0755 -p "$(DESTDIR)$(infodir)"
 128         install -m0644 $(INFO_INFO_FILES) $(DESTDIR)$(infodir)
 129         for file in $(INFO_INFO_FILES); do install-info $$file $(DESTDIR)$(infodir)/dir; done
 130 endif
 131
 132 $(dir)/config.dox: version.stamp
 133         echo "PROJECT_NAME = \"Notmuch $(VERSION)\"" > $@
 134         echo "INPUT=${srcdir}/lib/notmuch.h" >> $@
 135
 136 CLEAN := $(CLEAN) $(DOCBUILDDIR) $(DOCBUILDDIR)/.roff.stamp
 137 CLEAN := $(CLEAN) $(MAN_GZIP_FILES) $(MAN_ROFF_FILES) $(dir)/conf.pyc $(dir)/config.dox