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