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