Return-Path: X-Original-To: notmuch@notmuchmail.org Delivered-To: notmuch@notmuchmail.org Received: from localhost (localhost [127.0.0.1]) by olra.theworths.org (Postfix) with ESMTP id 17A54431FD2 for ; Tue, 1 Jul 2014 09:42:25 -0700 (PDT) X-Virus-Scanned: Debian amavisd-new at olra.theworths.org X-Spam-Flag: NO X-Spam-Score: 0 X-Spam-Level: X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none] autolearn=disabled Received: from olra.theworths.org ([127.0.0.1]) by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id FI8TvO+nNr0P for ; Tue, 1 Jul 2014 09:42:19 -0700 (PDT) Received: from mx.xen14.node3324.gplhost.com (gitolite.debian.net [87.98.215.224]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by olra.theworths.org (Postfix) with ESMTPS id CE9F8431FC3 for ; Tue, 1 Jul 2014 09:42:18 -0700 (PDT) Received: from remotemail by mx.xen14.node3324.gplhost.com with local (Exim 4.72) (envelope-from ) id 1X217h-0005xg-8W; Tue, 01 Jul 2014 16:41:37 +0000 Received: (nullmailer pid 13974 invoked by uid 1000); Tue, 01 Jul 2014 16:40:41 -0000 From: David Bremner To: notmuch@notmuchmail.org Subject: [PATCH 1/2] doc: build and install doxygen api docs Date: Tue, 1 Jul 2014 13:40:33 -0300 Message-Id: <1404232834-13777-2-git-send-email-david@tethera.net> X-Mailer: git-send-email 2.0.0.rc2 In-Reply-To: <1404232834-13777-1-git-send-email-david@tethera.net> References: <1396749744-19638-3-git-send-email-david@tethera.net> <1404232834-13777-1-git-send-email-david@tethera.net> X-BeenThere: notmuch@notmuchmail.org X-Mailman-Version: 2.1.13 Precedence: list List-Id: "Use and development of the notmuch mail system." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 01 Jul 2014 16:42:25 -0000 Add to the build-man and install-man targets. We also stop hardcoding the version information into doxygen.cfg --- doc/Makefile.local | 14 ++++++++++++-- doc/doxygen.cfg | 4 ++-- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/doc/Makefile.local b/doc/Makefile.local index bbd4610..e9402b4 100644 --- a/doc/Makefile.local +++ b/doc/Makefile.local @@ -12,6 +12,8 @@ mkdocdeps := python $(srcdir)/$(dir)/mkdocdeps.py # Internal variables. ALLSPHINXOPTS := -d $(DOCBUILDDIR)/doctrees $(SPHINXOPTS) $(srcdir)/$(dir) +APIMAN := $(DOCBUILDDIR)/man/man3/notmuch.3 +DOXYFILE := $(dir)/doxygen.cfg .PHONY: sphinx-html sphinx-texinfo sphinx-info @@ -31,7 +33,7 @@ sphinx-info: sphinx-texinfo -include $(dir)/docdeps.mk -MAN_GZIP_FILES := $(addsuffix .gz,${MAN_ROFF_FILES}) +MAN_GZIP_FILES := $(addsuffix .gz,${MAN_ROFF_FILES} ${APIMAN}) # Use the man page converter that is available. We should never depend # on MAN_ROFF_FILES if a converter is not available. @@ -66,16 +68,24 @@ else build-man: ${MAN_GZIP_FILES} install-man: ${MAN_GZIP_FILES} mkdir -p "$(DESTDIR)$(mandir)/man1" + mkdir -p "$(DESTDIR)$(mandir)/man3" mkdir -p "$(DESTDIR)$(mandir)/man5" mkdir -p "$(DESTDIR)$(mandir)/man7" install -m0644 $(DOCBUILDDIR)/man/man1/*.1.gz $(DESTDIR)/$(mandir)/man1 + install -m0644 $(DOCBUILDDIR)/man/man3/*.3.gz $(DESTDIR)/$(mandir)/man3 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 +$(APIMAN): $(dir)/version.dox $(dir)/doxygen.cfg $(srcdir)/lib/notmuch.h + doxygen $(DOXYFILE) + +$(dir)/version.dox: version.stamp + echo "PROJECT_NAME = \"Notmuch $(VERSION)\"" > $@ + $(dir)/docdeps.mk: $(dir)/conf.py $(dir)/mkdocdeps.py $(mkdocdeps) $(srcdir)/doc $(DOCBUILDDIR) $@ CLEAN := $(CLEAN) $(DOCBUILDDIR) $(dir)/docdeps.mk $(DOCBUILDDIR)/.roff.stamp -CLEAN := $(CLEAN) $(MAN_GZIP_FILES) $(MAN_ROFF_FILES) $(dir)/conf.pyc +CLEAN := $(CLEAN) $(MAN_GZIP_FILES) $(MAN_ROFF_FILES) $(dir)/conf.pyc $(dir)/version.dox diff --git a/doc/doxygen.cfg b/doc/doxygen.cfg index bfbfcab..bf9f075 100644 --- a/doc/doxygen.cfg +++ b/doc/doxygen.cfg @@ -4,11 +4,11 @@ # Project related configuration options #--------------------------------------------------------------------------- DOXYFILE_ENCODING = UTF-8 -PROJECT_NAME = "Notmuch 0.18" +@INCLUDE = "doc/version.dox" PROJECT_NUMBER = PROJECT_BRIEF = PROJECT_LOGO = -OUTPUT_DIRECTORY = +OUTPUT_DIRECTORY = doc/_build CREATE_SUBDIRS = NO OUTPUT_LANGUAGE = English BRIEF_MEMBER_DESC = YES -- 2.0.0.rc2