a3/0c3356e1df51f96b6cd37c9875d3fe48697b66

   1 Return-Path: <bremner@tesseract.cs.unb.ca>\r
   2 X-Original-To: notmuch@notmuchmail.org\r
   3 Delivered-To: notmuch@notmuchmail.org\r
   4 Received: from localhost (localhost [127.0.0.1])\r
   5         by olra.theworths.org (Postfix) with ESMTP id 17A54431FD2\r
   6         for <notmuch@notmuchmail.org>; Tue,  1 Jul 2014 09:42:25 -0700 (PDT)\r
   7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
   8 X-Spam-Flag: NO\r
   9 X-Spam-Score: 0\r
  10 X-Spam-Level: \r
  11 X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\r
  12         autolearn=disabled\r
  13 Received: from olra.theworths.org ([127.0.0.1])\r
  14         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
  15         with ESMTP id FI8TvO+nNr0P for <notmuch@notmuchmail.org>;\r
  16         Tue,  1 Jul 2014 09:42:19 -0700 (PDT)\r
  17 Received: from mx.xen14.node3324.gplhost.com (gitolite.debian.net\r
  18         [87.98.215.224]) (using TLSv1 with cipher AES256-SHA (256/256 bits))\r
  19         (No client certificate requested)\r
  20         by olra.theworths.org (Postfix) with ESMTPS id CE9F8431FC3\r
  21         for <notmuch@notmuchmail.org>; Tue,  1 Jul 2014 09:42:18 -0700 (PDT)\r
  22 Received: from remotemail by mx.xen14.node3324.gplhost.com with local (Exim\r
  23         4.72) (envelope-from <bremner@tesseract.cs.unb.ca>)\r
  24         id 1X217h-0005xg-8W; Tue, 01 Jul 2014 16:41:37 +0000\r
  25 Received: (nullmailer pid 13974 invoked by uid 1000); Tue, 01 Jul 2014\r
  26         16:40:41 -0000\r
  27 From: David Bremner <david@tethera.net>\r
  28 To: notmuch@notmuchmail.org\r
  29 Subject: [PATCH 1/2] doc: build and install doxygen api docs\r
  30 Date: Tue,  1 Jul 2014 13:40:33 -0300\r
  31 Message-Id: <1404232834-13777-2-git-send-email-david@tethera.net>\r
  32 X-Mailer: git-send-email 2.0.0.rc2\r
  33 In-Reply-To: <1404232834-13777-1-git-send-email-david@tethera.net>\r
  34 References: <1396749744-19638-3-git-send-email-david@tethera.net>\r
  35         <1404232834-13777-1-git-send-email-david@tethera.net>\r
  36 X-BeenThere: notmuch@notmuchmail.org\r
  37 X-Mailman-Version: 2.1.13\r
  38 Precedence: list\r
  39 List-Id: "Use and development of the notmuch mail system."\r
  40         <notmuch.notmuchmail.org>\r
  41 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  42         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  43 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  44 List-Post: <mailto:notmuch@notmuchmail.org>\r
  45 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  46 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  47         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  48 X-List-Received-Date: Tue, 01 Jul 2014 16:42:25 -0000\r
  49 \r
  50 Add to the build-man and install-man targets. We also stop hardcoding\r
  51 the version information into doxygen.cfg\r
  52 ---\r
  53  doc/Makefile.local | 14 ++++++++++++--\r
  54  doc/doxygen.cfg    |  4 ++--\r
  55  2 files changed, 14 insertions(+), 4 deletions(-)\r
  56 \r
  57 diff --git a/doc/Makefile.local b/doc/Makefile.local\r
  58 index bbd4610..e9402b4 100644\r
  59 --- a/doc/Makefile.local\r
  60 +++ b/doc/Makefile.local\r
  61 @@ -12,6 +12,8 @@ mkdocdeps := python $(srcdir)/$(dir)/mkdocdeps.py\r
  62  \r
  63  # Internal variables.\r
  64  ALLSPHINXOPTS   := -d $(DOCBUILDDIR)/doctrees $(SPHINXOPTS) $(srcdir)/$(dir)\r
  65 +APIMAN         := $(DOCBUILDDIR)/man/man3/notmuch.3\r
  66 +DOXYFILE       := $(dir)/doxygen.cfg\r
  67  \r
  68  .PHONY: sphinx-html sphinx-texinfo sphinx-info\r
  69  \r
  70 @@ -31,7 +33,7 @@ sphinx-info: sphinx-texinfo\r
  71  \r
  72  -include $(dir)/docdeps.mk\r
  73  \r
  74 -MAN_GZIP_FILES := $(addsuffix .gz,${MAN_ROFF_FILES})\r
  75 +MAN_GZIP_FILES := $(addsuffix .gz,${MAN_ROFF_FILES} ${APIMAN})\r
  76  \r
  77  # Use the man page converter that is available. We should never depend\r
  78  # on MAN_ROFF_FILES if a converter is not available.\r
  79 @@ -66,16 +68,24 @@ else\r
  80  build-man: ${MAN_GZIP_FILES}\r
  81  install-man: ${MAN_GZIP_FILES}\r
  82         mkdir -p "$(DESTDIR)$(mandir)/man1"\r
  83 +       mkdir -p "$(DESTDIR)$(mandir)/man3"\r
  84         mkdir -p "$(DESTDIR)$(mandir)/man5"\r
  85         mkdir -p "$(DESTDIR)$(mandir)/man7"\r
  86         install -m0644 $(DOCBUILDDIR)/man/man1/*.1.gz $(DESTDIR)/$(mandir)/man1\r
  87 +       install -m0644 $(DOCBUILDDIR)/man/man3/*.3.gz $(DESTDIR)/$(mandir)/man3\r
  88         install -m0644 $(DOCBUILDDIR)/man/man5/*.5.gz $(DESTDIR)/$(mandir)/man5\r
  89         install -m0644 $(DOCBUILDDIR)/man/man7/*.7.gz $(DESTDIR)/$(mandir)/man7\r
  90         cd $(DESTDIR)/$(mandir)/man1 && ln -sf notmuch.1.gz notmuch-setup.1.gz\r
  91  endif\r
  92  \r
  93 +$(APIMAN): $(dir)/version.dox $(dir)/doxygen.cfg $(srcdir)/lib/notmuch.h\r
  94 +       doxygen $(DOXYFILE)\r
  95 +\r
  96 +$(dir)/version.dox: version.stamp\r
  97 +       echo "PROJECT_NAME = \"Notmuch $(VERSION)\"" > $@\r
  98 +\r
  99  $(dir)/docdeps.mk: $(dir)/conf.py $(dir)/mkdocdeps.py\r
 100         $(mkdocdeps) $(srcdir)/doc $(DOCBUILDDIR) $@\r
 101  \r
 102  CLEAN := $(CLEAN) $(DOCBUILDDIR) $(dir)/docdeps.mk $(DOCBUILDDIR)/.roff.stamp\r
 103 -CLEAN := $(CLEAN) $(MAN_GZIP_FILES) $(MAN_ROFF_FILES) $(dir)/conf.pyc\r
 104 +CLEAN := $(CLEAN) $(MAN_GZIP_FILES) $(MAN_ROFF_FILES) $(dir)/conf.pyc $(dir)/version.dox\r
 105 diff --git a/doc/doxygen.cfg b/doc/doxygen.cfg\r
 106 index bfbfcab..bf9f075 100644\r
 107 --- a/doc/doxygen.cfg\r
 108 +++ b/doc/doxygen.cfg\r
 109 @@ -4,11 +4,11 @@\r
 110  # Project related configuration options\r
 111  #---------------------------------------------------------------------------\r
 112  DOXYFILE_ENCODING      = UTF-8\r
 113 -PROJECT_NAME           = "Notmuch 0.18"\r
 114 +@INCLUDE              =  "doc/version.dox"\r
 115  PROJECT_NUMBER         =\r
 116  PROJECT_BRIEF          =\r
 117  PROJECT_LOGO           =\r
 118 -OUTPUT_DIRECTORY       =\r
 119 +OUTPUT_DIRECTORY       = doc/_build\r
 120  CREATE_SUBDIRS         = NO\r
 121  OUTPUT_LANGUAGE        = English\r
 122  BRIEF_MEMBER_DESC      = YES\r
 123 -- \r
 124 2.0.0.rc2\r
 125 \r