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 -c $(dir)
   7 SPHINXBUILD   = sphinx-build
   8 DOCBUILDDIR      := $(dir)/_build
   9
  10 prerst2man := python $(dir)/prerst2man.py
  11 mkdocdeps := python $(dir)/mkdocdeps.py
  12
  13 # Internal variables.
  14 ALLSPHINXOPTS   := -d $(DOCBUILDDIR)/doctrees $(SPHINXOPTS) $(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}: ${MAN_RST_FILES}
  39 ifeq ($(HAVE_SPHINX),1)
  40         $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(DOCBUILDDIR)/man
  41         for section in 1 5 7; do \
  42             mkdir -p $(DOCBUILDDIR)/man/man$${section}; \
  43             mv $(DOCBUILDDIR)/man/*.$${section} $(DOCBUILDDIR)/man/man$${section}; \
  44         done
  45 else ifeq ($(HAVE_RST2MAN),1)
  46         $(prerst2man) $(DOCBUILDDIR)/.. $(DOCBUILDDIR)/man
  47 else
  48         @echo "Fatal: build dependency fail."
  49         @false
  50 endif
  51
  52 # Do not try to build or install man pages if a man page converter is
  53 # not available.
  54 ifeq ($(HAVE_SPHINX)$(HAVE_RST2MAN),00)
  55 build-man:
  56 install-man:
  57         @echo "No sphinx or rst2man, will not install man pages."
  58 else
  59 build-man: ${MAN_GZIP_FILES}
  60 install-man: ${MAN_GZIP_FILES}
  61         mkdir -p "$(DESTDIR)$(mandir)/man1"
  62         mkdir -p "$(DESTDIR)$(mandir)/man5"
  63         mkdir -p "$(DESTDIR)$(mandir)/man7"
  64         install -m0644 $(DOCBUILDDIR)/man/man1/*.1.gz $(DESTDIR)/$(mandir)/man1
  65         install -m0644 $(DOCBUILDDIR)/man/man5/*.5.gz $(DESTDIR)/$(mandir)/man5
  66         install -m0644 $(DOCBUILDDIR)/man/man7/*.7.gz $(DESTDIR)/$(mandir)/man7
  67         cd $(DESTDIR)/$(mandir)/man1 && ln -sf notmuch.1.gz notmuch-setup.1.gz
  68 endif
  69
  70 $(dir)/docdeps.mk: $(dir)/conf.py $(dir)/mkdocdeps.py
  71         $(mkdocdeps) $< $(DOCBUILDDIR) $@
  72
  73 CLEAN := $(CLEAN) $(DOCBUILDDIR) $(dir)/docdeps.mk $(dir)/man.stamp
  74 CLEAN := $(CLEAN) $(MAN_GZIP_FILES) $(MAN_ROFF_FILES)