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 APIMAN          := $(DOCBUILDDIR)/man/man3/notmuch.3
  16 DOXYFILE        := $(srcdir)/$(dir)/doxygen.cfg
  17
  18 .PHONY: sphinx-html sphinx-texinfo sphinx-info
  19
  20 .PHONY: install-man build-man apidocs install-apidocs
  21
  22 %.gz: %
  23         rm -f $@ && gzip --stdout $^ > $@
  24
  25 sphinx-html:
  26         $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(DOCBUILDDIR)/html
  27
  28 sphinx-texinfo:
  29         $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(DOCBUILDDIR)/texinfo
  30
  31 sphinx-info: sphinx-texinfo
  32         make -C $(DOCBUILDDIR)/texinfo info
  33
  34 -include $(dir)/docdeps.mk
  35
  36 MAN_GZIP_FILES := $(addsuffix .gz,${MAN_ROFF_FILES})
  37
  38 # Use the man page converter that is available. We should never depend
  39 # on MAN_ROFF_FILES if a converter is not available.
  40 ${MAN_ROFF_FILES}: $(DOCBUILDDIR)/.roff.stamp
  41
  42 # By using $(DOCBUILDDIR)/.roff.stamp instead of ${MAN_ROFF_FILES}, we
  43 # convey to make that a single invocation of this recipe builds all
  44 # of the roff files.  This prevents parallel make from starting an
  45 # instance of this recipe for each roff file.
  46 $(DOCBUILDDIR)/.roff.stamp: ${MAN_RST_FILES}
  47 ifeq ($(HAVE_SPHINX),1)
  48         $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(DOCBUILDDIR)/man
  49         for section in 1 5 7; do \
  50             mkdir -p $(DOCBUILDDIR)/man/man$${section}; \
  51             mv $(DOCBUILDDIR)/man/*.$${section} $(DOCBUILDDIR)/man/man$${section}; \
  52         done
  53 else ifeq ($(HAVE_RST2MAN),1)
  54         $(prerst2man) $(srcdir)/doc $(DOCBUILDDIR)/man
  55 else
  56         @echo "Fatal: build dependency fail."
  57         @false
  58 endif
  59         touch ${MAN_ROFF_FILES} $@
  60
  61 install-man: install-apidocs
  62
  63 ifeq ($(HAVE_DOXYGEN),1)
  64 MAN_GZIP_FILES += ${APIMAN}.gz
  65 apidocs: $(APIMAN)
  66 install-apidocs: apidocs
  67         mkdir -p "$(DESTDIR)$(mandir)/man3"
  68         install -m0644  $(DOCBUILDDIR)/man/man3/*.3.gz  $(DESTDIR)/$(mandir)/man3
  69
  70 $(APIMAN): $(dir)/config.dox $(srcdir)/$(dir)/doxygen.cfg $(srcdir)/lib/notmuch.h
  71         mkdir -p $(DOCBUILDDIR)/man/man3
  72         doxygen $(DOXYFILE)
  73         perl -pi -e 's/^[.]RI "\\fI/.RI "\\fP/' $(APIMAN)
  74 else
  75 apidocs:
  76 install-apidocs:
  77 endif
  78
  79 # Do not try to build or install man pages if a man page converter is
  80 # not available.
  81 ifeq ($(HAVE_SPHINX)$(HAVE_RST2MAN),00)
  82 build-man:
  83 install-man:
  84         @echo "No sphinx or rst2man, will not install man pages."
  85 else
  86 build-man: ${MAN_GZIP_FILES}
  87 install-man: ${MAN_GZIP_FILES}
  88         mkdir -p "$(DESTDIR)$(mandir)/man1"
  89         mkdir -p "$(DESTDIR)$(mandir)/man5"
  90         mkdir -p "$(DESTDIR)$(mandir)/man7"
  91         install -m0644 $(DOCBUILDDIR)/man/man1/*.1.gz $(DESTDIR)/$(mandir)/man1
  92         install -m0644 $(DOCBUILDDIR)/man/man5/*.5.gz $(DESTDIR)/$(mandir)/man5
  93         install -m0644 $(DOCBUILDDIR)/man/man7/*.7.gz $(DESTDIR)/$(mandir)/man7
  94         cd $(DESTDIR)/$(mandir)/man1 && ln -sf notmuch.1.gz notmuch-setup.1.gz
  95 endif
  96
  97 $(dir)/config.dox: version.stamp
  98         echo "PROJECT_NAME = \"Notmuch $(VERSION)\"" > $@
  99         echo "INPUT=${srcdir}/lib/notmuch.h" >> $@
 100
 101 $(dir)/docdeps.mk: $(dir)/conf.py $(dir)/mkdocdeps.py
 102         $(mkdocdeps) $(srcdir)/doc $(DOCBUILDDIR) $@
 103
 104 CLEAN := $(CLEAN) $(DOCBUILDDIR) $(dir)/docdeps.mk $(DOCBUILDDIR)/.roff.stamp
 105 CLEAN := $(CLEAN) $(MAN_GZIP_FILES) $(MAN_ROFF_FILES) $(dir)/conf.pyc $(dir)/config.dox