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 prerst2man := python $(srcdir)/$(dir)/prerst2man.py
  11 mkdocdeps := python $(srcdir)/$(dir)/mkdocdeps.py
  12
  13 # Internal variables.
  14 ALLSPHINXOPTS   := -d $(DOCBUILDDIR)/doctrees $(SPHINXOPTS) $(srcdir)/$(dir)
  15
  16 .PHONY: sphinx-html sphinx-texinfo sphinx-info
  17
  18 .PHONY: install-man build-man
  19
  20 %.gz: %
  21         rm -f $@ && gzip --stdout $^ > $@
  22
  23 sphinx-html:
  24         $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(DOCBUILDDIR)/html
  25
  26 sphinx-texinfo:
  27         $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(DOCBUILDDIR)/texinfo
  28
  29 sphinx-info: sphinx-texinfo
  30         make -C $(DOCBUILDDIR)/texinfo info
  31
  32 -include $(dir)/docdeps.mk
  33
  34 MAN_GZIP_FILES := $(addsuffix .gz,${MAN_ROFF_FILES})
  35
  36 # Use the man page converter that is available. We should never depend
  37 # on MAN_ROFF_FILES if a converter is not available.
  38 ${MAN_ROFF_FILES}: $(DOCBUILDDIR)/.roff.stamp
  39
  40 # By using $(DOCBUILDDIR)/.roff.stamp instead of ${MAN_ROFF_FILES}, we
  41 # convey to make that a single invocation of this recipe builds all
  42 # of the roff files.  This prevents parallel make from starting an
  43 # instance of this recipe for each roff file.
  44 $(DOCBUILDDIR)/.roff.stamp: ${MAN_RST_FILES}
  45 ifeq ($(HAVE_SPHINX),1)
  46         $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(DOCBUILDDIR)/man
  47         for section in 1 5 7; do \
  48             mkdir -p $(DOCBUILDDIR)/man/man$${section}; \
  49             mv $(DOCBUILDDIR)/man/*.$${section} $(DOCBUILDDIR)/man/man$${section}; \
  50         done
  51 else ifeq ($(HAVE_RST2MAN),1)
  52         $(prerst2man) $(srcdir)/doc $(DOCBUILDDIR)/man
  53 else
  54         @echo "Fatal: build dependency fail."
  55         @false
  56 endif
  57         touch ${MAN_ROFF_FILES} $@
  58
  59 # Do not try to build or install man pages if a man page converter is
  60 # not available.
  61 ifeq ($(HAVE_SPHINX)$(HAVE_RST2MAN),00)
  62 build-man:
  63 install-man:
  64         @echo "No sphinx or rst2man, will not install man pages."
  65 else
  66 build-man: ${MAN_GZIP_FILES}
  67 install-man: ${MAN_GZIP_FILES}
  68         mkdir -p "$(DESTDIR)$(mandir)/man1"
  69         mkdir -p "$(DESTDIR)$(mandir)/man5"
  70         mkdir -p "$(DESTDIR)$(mandir)/man7"
  71         install -m0644 $(DOCBUILDDIR)/man/man1/*.1.gz $(DESTDIR)/$(mandir)/man1
  72         install -m0644 $(DOCBUILDDIR)/man/man5/*.5.gz $(DESTDIR)/$(mandir)/man5
  73         install -m0644 $(DOCBUILDDIR)/man/man7/*.7.gz $(DESTDIR)/$(mandir)/man7
  74         cd $(DESTDIR)/$(mandir)/man1 && ln -sf notmuch.1.gz notmuch-setup.1.gz
  75 endif
  76
  77 $(dir)/docdeps.mk: $(dir)/conf.py $(dir)/mkdocdeps.py
  78         $(mkdocdeps) $(srcdir)/doc $(DOCBUILDDIR) $@
  79
  80 CLEAN := $(CLEAN) $(DOCBUILDDIR) $(dir)/docdeps.mk $(DOCBUILDDIR)/.roff.stamp
  81 CLEAN := $(CLEAN) $(MAN_GZIP_FILES) $(MAN_ROFF_FILES) $(dir)/conf.pyc