From 73a31dd1c25326517e13eb8008689dc3b3b6d171 Mon Sep 17 00:00:00 2001 From: David Bremner Date: Sun, 6 Apr 2014 23:02:24 +2100 Subject: [PATCH] [PATCH 2/2] doc: build and install doxygen api docs --- bc/7ac809ef2ebd4647fe5d3ab7eed9cccd07b6f0 | 125 ++++++++++++++++++++++ 1 file changed, 125 insertions(+) create mode 100644 bc/7ac809ef2ebd4647fe5d3ab7eed9cccd07b6f0 diff --git a/bc/7ac809ef2ebd4647fe5d3ab7eed9cccd07b6f0 b/bc/7ac809ef2ebd4647fe5d3ab7eed9cccd07b6f0 new file mode 100644 index 000000000..df20c459e --- /dev/null +++ b/bc/7ac809ef2ebd4647fe5d3ab7eed9cccd07b6f0 @@ -0,0 +1,125 @@ +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 3AA4B431FB6 + for ; Sat, 5 Apr 2014 19:03:55 -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 hOtjykn4n7cR for ; + Sat, 5 Apr 2014 19:03:49 -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 EDB6A431FAF + for ; Sat, 5 Apr 2014 19:03:48 -0700 (PDT) +Received: from remotemail by mx.xen14.node3324.gplhost.com with local (Exim + 4.72) (envelope-from ) + id 1WWcQN-0001Y0-1V; Sun, 06 Apr 2014 02:03:07 +0000 +Received: (nullmailer pid 19885 invoked by uid 1000); Sun, 06 Apr 2014 + 02:02:27 -0000 +From: David Bremner +To: notmuch@notmuchmail.org +Subject: [PATCH 2/2] doc: build and install doxygen api docs +Date: Sat, 5 Apr 2014 23:02:24 -0300 +Message-Id: <1396749744-19638-3-git-send-email-david@tethera.net> +X-Mailer: git-send-email 1.9.0 +In-Reply-To: <1396749744-19638-1-git-send-email-david@tethera.net> +References: <1389000116-16702-1-git-send-email-tomi.ollila@iki.fi> + <1396749744-19638-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: Sun, 06 Apr 2014 02:03:55 -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 0980c71..5189f97 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. +@@ -59,16 +61,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: $(srcdir)/version ++ sed -e 's/^/PROJECT_NAME = \"Notmuch /' -e 's/$$/\"/' < $< > $@ ++ + $(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) ++CLEAN := $(CLEAN) $(MAN_GZIP_FILES) $(MAN_ROFF_FILES) $(dir)/version.dox +diff --git a/doc/doxygen.cfg b/doc/doxygen.cfg +index 65d5fb5..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.17" ++@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 +-- +1.9.0 + -- 2.26.2