X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=doc%2FMakefile.local;h=5dc1cad489cc4722252962d4dc70fbd5aa20de5d;hp=23f40952861ee0f9a1cef6ad1a9fe60bea11bdc2;hb=a7a683b120ea8be1fe619d12a7d8a201de0652e6;hpb=9d9a700f1de6352b4f51a00ab80f2fcd70da050d diff --git a/doc/Makefile.local b/doc/Makefile.local index 23f40952..5dc1cad4 100644 --- a/doc/Makefile.local +++ b/doc/Makefile.local @@ -3,19 +3,20 @@ dir := doc # You can set these variables from the command line. -SPHINXOPTS := -q -c $(dir) +SPHINXOPTS := -q SPHINXBUILD = sphinx-build DOCBUILDDIR := $(dir)/_build -prerst2man := python $(dir)/prerst2man.py -mkdocdeps := python $(dir)/mkdocdeps.py +mkdocdeps := $(PYTHON) $(srcdir)/$(dir)/mkdocdeps.py # Internal variables. -ALLSPHINXOPTS := -d $(DOCBUILDDIR)/doctrees $(SPHINXOPTS) $(dir) +ALLSPHINXOPTS := -d $(DOCBUILDDIR)/doctrees $(SPHINXOPTS) $(srcdir)/$(dir) +APIMAN := $(DOCBUILDDIR)/man/man3/notmuch.3 +DOXYFILE := $(srcdir)/$(dir)/doxygen.cfg .PHONY: sphinx-html sphinx-texinfo sphinx-info -.PHONY: install-man build-man +.PHONY: install-man build-man apidocs install-apidocs %.gz: % rm -f $@ && gzip --stdout $^ > $@ @@ -33,32 +34,70 @@ sphinx-info: sphinx-texinfo MAN_GZIP_FILES := $(addsuffix .gz,${MAN_ROFF_FILES}) -build-man: ${MAN_GZIP_FILES} - -${MAN_ROFF_FILES}: ${dir}/man.stamp +# Use the man page converter that is available. We should never depend +# on MAN_ROFF_FILES if a converter is not available. +${MAN_ROFF_FILES}: $(DOCBUILDDIR)/.roff.stamp -$(dir)/man.stamp: ${MAN_RST_FILES} +# By using $(DOCBUILDDIR)/.roff.stamp instead of ${MAN_ROFF_FILES}, we +# convey to make that a single invocation of this recipe builds all +# of the roff files. This prevents parallel make from starting an +# instance of this recipe for each roff file. +$(DOCBUILDDIR)/.roff.stamp: ${MAN_RST_FILES} ifeq ($(HAVE_SPHINX),1) $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(DOCBUILDDIR)/man + for section in 1 5 7; do \ + mkdir -p $(DOCBUILDDIR)/man/man$${section}; \ + mv $(DOCBUILDDIR)/man/*.$${section} $(DOCBUILDDIR)/man/man$${section}; \ + done +else + @echo "Fatal: build dependency fail." + @false +endif touch $@ -else ifeq ($(HAVE_RST2MAN),1) - $(prerst2man) $(DOCBUILDDIR)/.. $(DOCBUILDDIR)/man - touch $@ + +install-man: install-apidocs + +ifeq ($(HAVE_DOXYGEN),1) +MAN_GZIP_FILES += ${APIMAN}.gz +apidocs: $(APIMAN) +install-apidocs: ${APIMAN}.gz + mkdir -p "$(DESTDIR)$(mandir)/man3" + install -m0644 $(DOCBUILDDIR)/man/man3/*.3.gz $(DESTDIR)/$(mandir)/man3 + +$(APIMAN): $(dir)/config.dox $(srcdir)/$(dir)/doxygen.cfg $(srcdir)/lib/notmuch.h + mkdir -p $(DOCBUILDDIR)/man/man3 + doxygen $(DOXYFILE) + rm -f $(DOCBUILDDIR)/man/man3/_*.3 + perl -pi -e 's/^[.]RI "\\fI/.RI "\\fP/' $(APIMAN) else - @echo "No sphinx or rst2man, will not install man pages." +apidocs: +install-apidocs: endif +# Do not try to build or install man pages if a man page converter is +# not available. +ifeq ($(HAVE_SPHINX),0) +build-man: +install-man: + @echo "No sphinx, will not install man pages." +else +build-man: ${MAN_GZIP_FILES} install-man: ${MAN_GZIP_FILES} mkdir -p "$(DESTDIR)$(mandir)/man1" mkdir -p "$(DESTDIR)$(mandir)/man5" mkdir -p "$(DESTDIR)$(mandir)/man7" - install -m0644 $(DOCBUILDDIR)/man/*.1.gz $(DESTDIR)/$(mandir)/man1 - install -m0644 $(DOCBUILDDIR)/man/*.5.gz $(DESTDIR)/$(mandir)/man5 - install -m0644 $(DOCBUILDDIR)/man/*.7.gz $(DESTDIR)/$(mandir)/man7 + install -m0644 $(DOCBUILDDIR)/man/man1/*.1.gz $(DESTDIR)/$(mandir)/man1 + install -m0644 $(DOCBUILDDIR)/man/man5/*.5.gz $(DESTDIR)/$(mandir)/man5 + install -m0644 $(DOCBUILDDIR)/man/man7/*.7.gz $(DESTDIR)/$(mandir)/man7 cd $(DESTDIR)/$(mandir)/man1 && ln -sf notmuch.1.gz notmuch-setup.1.gz +endif + +$(dir)/config.dox: version.stamp + echo "PROJECT_NAME = \"Notmuch $(VERSION)\"" > $@ + echo "INPUT=${srcdir}/lib/notmuch.h" >> $@ $(dir)/docdeps.mk: $(dir)/conf.py $(dir)/mkdocdeps.py - $(mkdocdeps) $< $(DOCBUILDDIR) $@ + $(mkdocdeps) $(srcdir)/doc $(DOCBUILDDIR) $@ -CLEAN := $(CLEAN) $(DOCBUILDDIR) $(dir)/docdeps.mk $(dir)/man.stamp -CLEAN := $(CLEAN) $(MAN_GZIP_FILES) $(MAN_ROFF_FILES) +CLEAN := $(CLEAN) $(DOCBUILDDIR) $(dir)/docdeps.mk $(DOCBUILDDIR)/.roff.stamp +CLEAN := $(CLEAN) $(MAN_GZIP_FILES) $(MAN_ROFF_FILES) $(dir)/conf.pyc $(dir)/config.dox