X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=doc%2FMakefile.local;h=8a2f656bcad414091fe1076694ea3b206d5c2b82;hp=bbd46100dc2d011bf361ebdd92d7e66bf781c3a0;hb=76ab6e99625468b011723a6bd9d84be5fab15d02;hpb=95aa988a06496027300f09d9db863a5cd89b201c diff --git a/doc/Makefile.local b/doc/Makefile.local index bbd46100..8a2f656b 100644 --- a/doc/Makefile.local +++ b/doc/Makefile.local @@ -7,15 +7,26 @@ 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) $(srcdir)/$(dir) +APIMAN := $(DOCBUILDDIR)/man/man3/notmuch.3 +DOXYFILE := $(srcdir)/$(dir)/doxygen.cfg + +MAN1_RST := $(wildcard $(srcdir)/doc/man1/*.rst) +MAN5_RST := $(wildcard $(srcdir)/doc/man5/*.rst) +MAN7_RST := $(wildcard $(srcdir)/doc/man7/*.rst) +MAN_RST_FILES := $(MAN1_RST) $(MAN5_RST) $(MAN7_RST) + +MAN1_ROFF := $(patsubst $(srcdir)/doc/%,$(DOCBUILDDIR)/man/%,$(MAN1_RST:.rst=.1)) +MAN5_ROFF := $(patsubst $(srcdir)/doc/%,$(DOCBUILDDIR)/man/%,$(MAN5_RST:.rst=.5)) +MAN7_ROFF := $(patsubst $(srcdir)/doc/%,$(DOCBUILDDIR)/man/%,$(MAN7_RST:.rst=.7)) +MAN_ROFF_FILES := $(MAN1_ROFF) $(MAN5_ROFF) $(MAN7_ROFF) + +MAN_GZIP_FILES := $(addsuffix .gz,${MAN_ROFF_FILES}) .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 $^ > $@ @@ -29,10 +40,6 @@ sphinx-texinfo: sphinx-info: sphinx-texinfo make -C $(DOCBUILDDIR)/texinfo info --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}: $(DOCBUILDDIR)/.roff.stamp @@ -48,20 +55,37 @@ ifeq ($(HAVE_SPHINX),1) 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 - touch ${MAN_ROFF_FILES} $@ + 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 +apidocs: +install-apidocs: +endif # Do not try to build or install man pages if a man page converter is # not available. -ifeq ($(HAVE_SPHINX)$(HAVE_RST2MAN),00) +ifeq ($(HAVE_SPHINX),0) build-man: install-man: - @echo "No sphinx or rst2man, will not install man pages." + @echo "No sphinx, will not install man pages." else build-man: ${MAN_GZIP_FILES} install-man: ${MAN_GZIP_FILES} @@ -74,8 +98,9 @@ install-man: ${MAN_GZIP_FILES} 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) $@ +$(dir)/config.dox: version.stamp + echo "PROJECT_NAME = \"Notmuch $(VERSION)\"" > $@ + echo "INPUT=${srcdir}/lib/notmuch.h" >> $@ -CLEAN := $(CLEAN) $(DOCBUILDDIR) $(dir)/docdeps.mk $(DOCBUILDDIR)/.roff.stamp -CLEAN := $(CLEAN) $(MAN_GZIP_FILES) $(MAN_ROFF_FILES) $(dir)/conf.pyc +CLEAN := $(CLEAN) $(DOCBUILDDIR) $(DOCBUILDDIR)/.roff.stamp +CLEAN := $(CLEAN) $(MAN_GZIP_FILES) $(MAN_ROFF_FILES) $(dir)/conf.pyc $(dir)/config.dox