Re: [RFC Patch] start of sphinx based docs

diff --git a/ec/f4ed6c11a046a07060191200d6313f11affd23 b/ec/f4ed6c11a046a07060191200d6313f11affd23
new file mode 100644 (file)
index 0000000..416bf19
--- /dev/null
+++ b/ec/f4ed6c11a046a07060191200d6313f11affd23
@@ -0,0 +1,102 @@
+Return-Path: <tomi.ollila@iki.fi>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id 17FA4431FC0\r
+       for <notmuch@notmuchmail.org>; Sun, 19 Jan 2014 05:48:58 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\r
+       autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id Y2bM2q71ffDd for <notmuch@notmuchmail.org>;\r
+       Sun, 19 Jan 2014 05:48:50 -0800 (PST)\r
+Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34])\r
+       by olra.theworths.org (Postfix) with ESMTP id A222E431FBD\r
+       for <notmuch@notmuchmail.org>; Sun, 19 Jan 2014 05:48:50 -0800 (PST)\r
+Received: from guru.guru-group.fi (localhost [IPv6:::1])\r
+       by guru.guru-group.fi (Postfix) with ESMTP id 2EDDF10005D;\r
+       Sun, 19 Jan 2014 15:48:46 +0200 (EET)\r
+From: Tomi Ollila <tomi.ollila@iki.fi>\r
+To: David Bremner <david@tethera.net>, notmuch@notmuchmail.org\r
+Subject: Re: [RFC Patch] start of sphinx based docs\r
+In-Reply-To: <1390060858-30905-1-git-send-email-david@tethera.net>\r
+References: <1390060858-30905-1-git-send-email-david@tethera.net>\r
+User-Agent: Notmuch/0.17+34~g98b959f (http://notmuchmail.org) Emacs/24.3.1\r
+       (x86_64-unknown-linux-gnu)\r
+X-Face: HhBM'cA~<r"^Xv\KRN0P{vn'Y"Kd;zg_y3S[4)KSN~s?O\"QPoL\r
+       $[Xv_BD:i/F$WiEWax}R(MPS`^UaptOGD`*/=@\1lKoVa9tnrg0TW?"r7aRtgk[F\r
+       !)g;OY^,BjTbr)Np:%c_o'jj,Z\r
+Date: Sun, 19 Jan 2014 15:48:45 +0200\r
+Message-ID: <m2k3dw6q0y.fsf@guru.guru-group.fi>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Sun, 19 Jan 2014 13:48:58 -0000\r
+\r
+On Sat, Jan 18 2014, David Bremner <david@tethera.net> wrote:\r
+\r
+> ---\r
+>\r
+> here is quick and dirty start a sphinx based docs.\r
+> This has the advantage that everything is in rst, no mixed formats.\r
+>\r
+> things you might try, after installing sphinx (only tested with 1.2)\r
+>\r
+> % make -C doc man\r
+>\r
+> % make -C doc info\r
+>\r
+> % man -l doc/_build/man/notmuch-search.1\r
+>\r
+> % info -f doc/_build/texinfo/notmuch-emacs.info\r
+\r
+This looks like a good plan, only Makefile & conf.py is a bit noisy\r
+(like Jani's original Doxyfile)\r
+\r
+Also;\r
+centos 6$ sudo yum install python-sphinx\r
+...\r
+Downloading Packages:\r
+(1/5): python-babel-0.9.4-5.1.el6.noarch.rpm             | 1.4 MB     00:07    \r
+(2/5): python-jinja2-2.2.1-1.el6.x86_64.rpm              | 464 kB     00:02    \r
+(3/5): python-pygments-1.1.1-1.el6.noarch.rpm            | 561 kB     00:02    \r
+(4/5): python-setuptools-0.6.10-3.el6.noarch.rpm         | 335 kB     00:01    \r
+(5/5): python-sphinx-0.6.6-2.el6.noarch.rpm              | 486 kB     00:02  \r
+---------------------------------------------------------------------------\r
+Total                                           200 kB/s | 3.2 MB     00:16\r
+\r
+(python-docutils were already installed)\r
+I wonder how hard it is to install these on some systems...\r
+\r
+>\r
+>  doc/Makefile                 | 177 ++++++++++++++++++++++++++++\r
+>  doc/conf.py                  | 272 +++++++++++++++++++++++++++++++++++++++++++\r
+>  doc/index.rst                |  24 ++++\r
+>  doc/notmuch-emacs.rst        | 188 ++++++++++++++++++++++++++++++\r
+>  doc/notmuch-search-terms.rst | 255 ++++++++++++++++++++++++++++++++++++++++\r
+>  doc/notmuch-search.rst       | 203 ++++++++++++++++++++++++++++++++\r
+>  doc/notmuch.rst              | 173 +++++++++++++++++++++++++++\r
+>  7 files changed, 1292 insertions(+)\r
+>  create mode 100644 doc/Makefile\r
+>  create mode 100644 doc/conf.py\r
+>  create mode 100644 doc/index.rst\r
+>  create mode 100644 doc/notmuch-emacs.rst\r
+>  create mode 100644 doc/notmuch-search-terms.rst\r
+>  create mode 100644 doc/notmuch-search.rst\r
+>  create mode 100644 doc/notmuch.rst\r
+>\r