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