X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=doc%2FMakefile.local;h=0980c71c2ac3e0d792025d914b5010d446a7e954;hb=2a79d81211664ca3f0cd1a847795d48bd66b8a3d;hp=ec23012537f4884b3aee7a1a6b32d608834652e1;hpb=d736260385a689b5c77d8121f48e29440e3adfa4;p=notmuch diff --git a/doc/Makefile.local b/doc/Makefile.local index ec230125..0980c71c 100644 --- a/doc/Makefile.local +++ b/doc/Makefile.local @@ -3,25 +3,72 @@ 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 $(srcdir)/$(dir)/prerst2man.py +mkdocdeps := python $(srcdir)/$(dir)/mkdocdeps.py + # Internal variables. -ALLSPHINXOPTS := -d $(DOCBUILDDIR)/doctrees $(SPHINXOPTS) $(dir) +ALLSPHINXOPTS := -d $(DOCBUILDDIR)/doctrees $(SPHINXOPTS) $(srcdir)/$(dir) + +.PHONY: sphinx-html sphinx-texinfo sphinx-info + +.PHONY: install-man build-man -.PHONY: sphinx-html sphinx-man sphinx-texinfo sphinx-info +%.gz: % + rm -f $@ && gzip --stdout $^ > $@ sphinx-html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(DOCBUILDDIR)/html -sphinx-man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(DOCBUILDDIR)/man - sphinx-texinfo: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(DOCBUILDDIR)/texinfo sphinx-info: sphinx-texinfo make -C $(DOCBUILDDIR)/texinfo info -CLEAN := $(CLEAN) $(DOCBUILDDIR) +-include $(dir)/docdeps.mk + +MAN_GZIP_FILES := $(addsuffix .gz,${MAN_ROFF_FILES}) + +# 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}: ${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 ifeq ($(HAVE_RST2MAN),1) + $(prerst2man) $(srcdir)/doc $(DOCBUILDDIR)/man +else + @echo "Fatal: build dependency fail." + @false +endif + +# Do not try to build or install man pages if a man page converter is +# not available. +ifeq ($(HAVE_SPHINX)$(HAVE_RST2MAN),00) +build-man: +install-man: + @echo "No sphinx or rst2man, 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/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)/docdeps.mk: $(dir)/conf.py $(dir)/mkdocdeps.py + $(mkdocdeps) $(srcdir)/doc $(DOCBUILDDIR) $@ + +CLEAN := $(CLEAN) $(DOCBUILDDIR) $(dir)/docdeps.mk $(dir)/man.stamp +CLEAN := $(CLEAN) $(MAN_GZIP_FILES) $(MAN_ROFF_FILES)