From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <tomi.ollila@iki.fi>
Received: from localhost (localhost [127.0.0.1])
	by olra.theworths.org (Postfix) with ESMTP id 17FA4431FC0
	for <notmuch@notmuchmail.org>; Sun, 19 Jan 2014 05:48:58 -0800 (PST)
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 Y2bM2q71ffDd for <notmuch@notmuchmail.org>;
	Sun, 19 Jan 2014 05:48:50 -0800 (PST)
Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34])
	by olra.theworths.org (Postfix) with ESMTP id A222E431FBD
	for <notmuch@notmuchmail.org>; Sun, 19 Jan 2014 05:48:50 -0800 (PST)
Received: from guru.guru-group.fi (localhost [IPv6:::1])
	by guru.guru-group.fi (Postfix) with ESMTP id 2EDDF10005D;
	Sun, 19 Jan 2014 15:48:46 +0200 (EET)
From: Tomi Ollila <tomi.ollila@iki.fi>
To: David Bremner <david@tethera.net>, notmuch@notmuchmail.org
Subject: Re: [RFC Patch] start of sphinx based docs
In-Reply-To: <1390060858-30905-1-git-send-email-david@tethera.net>
References: <1390060858-30905-1-git-send-email-david@tethera.net>
User-Agent: Notmuch/0.17+34~g98b959f (http://notmuchmail.org) Emacs/24.3.1
	(x86_64-unknown-linux-gnu)
X-Face: HhBM'cA~<r"^Xv\KRN0P{vn'Y"Kd;zg_y3S[4)KSN~s?O\"QPoL
	$[Xv_BD:i/F$WiEWax}R(MPS`^UaptOGD`*/=@\1lKoVa9tnrg0TW?"r7aRtgk[F
	!)g;OY^,BjTbr)Np:%c_o'jj,Z
Date: Sun, 19 Jan 2014 15:48:45 +0200
Message-ID: <m2k3dw6q0y.fsf@guru.guru-group.fi>
MIME-Version: 1.0
Content-Type: text/plain
X-BeenThere: notmuch@notmuchmail.org
X-Mailman-Version: 2.1.13
Precedence: list
List-Id: "Use and development of the notmuch mail system."
	<notmuch.notmuchmail.org>
List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,
	<mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>
List-Archive: <http://notmuchmail.org/pipermail/notmuch>
List-Post: <mailto:notmuch@notmuchmail.org>
List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>
List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,
	<mailto:notmuch-request@notmuchmail.org?subject=subscribe>
X-List-Received-Date: Sun, 19 Jan 2014 13:48:58 -0000

On Sat, Jan 18 2014, David Bremner <david@tethera.net> wrote:

> ---
>
> here is quick and dirty start a sphinx based docs.
> This has the advantage that everything is in rst, no mixed formats.
>
> things you might try, after installing sphinx (only tested with 1.2)
>
> % make -C doc man
>
> % make -C doc info
>
> % man -l doc/_build/man/notmuch-search.1
>
> % info -f doc/_build/texinfo/notmuch-emacs.info

This looks like a good plan, only Makefile & conf.py is a bit noisy
(like Jani's original Doxyfile)

Also;
centos 6$ sudo yum install python-sphinx
...
Downloading Packages:
(1/5): python-babel-0.9.4-5.1.el6.noarch.rpm             | 1.4 MB     00:07    
(2/5): python-jinja2-2.2.1-1.el6.x86_64.rpm              | 464 kB     00:02    
(3/5): python-pygments-1.1.1-1.el6.noarch.rpm            | 561 kB     00:02    
(4/5): python-setuptools-0.6.10-3.el6.noarch.rpm         | 335 kB     00:01    
(5/5): python-sphinx-0.6.6-2.el6.noarch.rpm              | 486 kB     00:02  
---------------------------------------------------------------------------
Total                                           200 kB/s | 3.2 MB     00:16

(python-docutils were already installed)
I wonder how hard it is to install these on some systems...

>
>  doc/Makefile                 | 177 ++++++++++++++++++++++++++++
>  doc/conf.py                  | 272 +++++++++++++++++++++++++++++++++++++++++++
>  doc/index.rst                |  24 ++++
>  doc/notmuch-emacs.rst        | 188 ++++++++++++++++++++++++++++++
>  doc/notmuch-search-terms.rst | 255 ++++++++++++++++++++++++++++++++++++++++
>  doc/notmuch-search.rst       | 203 ++++++++++++++++++++++++++++++++
>  doc/notmuch.rst              | 173 +++++++++++++++++++++++++++
>  7 files changed, 1292 insertions(+)
>  create mode 100644 doc/Makefile
>  create mode 100644 doc/conf.py
>  create mode 100644 doc/index.rst
>  create mode 100644 doc/notmuch-emacs.rst
>  create mode 100644 doc/notmuch-search-terms.rst
>  create mode 100644 doc/notmuch-search.rst
>  create mode 100644 doc/notmuch.rst
>