Re: Hi all
[notmuch-archives.git] / ec / f4ed6c11a046a07060191200d6313f11affd23
1 Return-Path: <tomi.ollila@iki.fi>\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 17FA4431FC0\r
6         for <notmuch@notmuchmail.org>; Sun, 19 Jan 2014 05:48:58 -0800 (PST)\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 Y2bM2q71ffDd for <notmuch@notmuchmail.org>;\r
16         Sun, 19 Jan 2014 05:48:50 -0800 (PST)\r
17 Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34])\r
18         by olra.theworths.org (Postfix) with ESMTP id A222E431FBD\r
19         for <notmuch@notmuchmail.org>; Sun, 19 Jan 2014 05:48:50 -0800 (PST)\r
20 Received: from guru.guru-group.fi (localhost [IPv6:::1])\r
21         by guru.guru-group.fi (Postfix) with ESMTP id 2EDDF10005D;\r
22         Sun, 19 Jan 2014 15:48:46 +0200 (EET)\r
23 From: Tomi Ollila <tomi.ollila@iki.fi>\r
24 To: David Bremner <david@tethera.net>, notmuch@notmuchmail.org\r
25 Subject: Re: [RFC Patch] start of sphinx based docs\r
26 In-Reply-To: <1390060858-30905-1-git-send-email-david@tethera.net>\r
27 References: <1390060858-30905-1-git-send-email-david@tethera.net>\r
28 User-Agent: Notmuch/0.17+34~g98b959f (http://notmuchmail.org) Emacs/24.3.1\r
29         (x86_64-unknown-linux-gnu)\r
30 X-Face: HhBM'cA~<r"^Xv\KRN0P{vn'Y"Kd;zg_y3S[4)KSN~s?O\"QPoL\r
31         $[Xv_BD:i/F$WiEWax}R(MPS`^UaptOGD`*/=@\1lKoVa9tnrg0TW?"r7aRtgk[F\r
32         !)g;OY^,BjTbr)Np:%c_o'jj,Z\r
33 Date: Sun, 19 Jan 2014 15:48:45 +0200\r
34 Message-ID: <m2k3dw6q0y.fsf@guru.guru-group.fi>\r
35 MIME-Version: 1.0\r
36 Content-Type: text/plain\r
37 X-BeenThere: notmuch@notmuchmail.org\r
38 X-Mailman-Version: 2.1.13\r
39 Precedence: list\r
40 List-Id: "Use and development of the notmuch mail system."\r
41         <notmuch.notmuchmail.org>\r
42 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
43         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
44 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
45 List-Post: <mailto:notmuch@notmuchmail.org>\r
46 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
47 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
48         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
49 X-List-Received-Date: Sun, 19 Jan 2014 13:48:58 -0000\r
50 \r
51 On Sat, Jan 18 2014, David Bremner <david@tethera.net> wrote:\r
52 \r
53 > ---\r
54 >\r
55 > here is quick and dirty start a sphinx based docs.\r
56 > This has the advantage that everything is in rst, no mixed formats.\r
57 >\r
58 > things you might try, after installing sphinx (only tested with 1.2)\r
59 >\r
60 > % make -C doc man\r
61 >\r
62 > % make -C doc info\r
63 >\r
64 > % man -l doc/_build/man/notmuch-search.1\r
65 >\r
66 > % info -f doc/_build/texinfo/notmuch-emacs.info\r
67 \r
68 This looks like a good plan, only Makefile & conf.py is a bit noisy\r
69 (like Jani's original Doxyfile)\r
70 \r
71 Also;\r
72 centos 6$ sudo yum install python-sphinx\r
73 ...\r
74 Downloading Packages:\r
75 (1/5): python-babel-0.9.4-5.1.el6.noarch.rpm             | 1.4 MB     00:07    \r
76 (2/5): python-jinja2-2.2.1-1.el6.x86_64.rpm              | 464 kB     00:02    \r
77 (3/5): python-pygments-1.1.1-1.el6.noarch.rpm            | 561 kB     00:02    \r
78 (4/5): python-setuptools-0.6.10-3.el6.noarch.rpm         | 335 kB     00:01    \r
79 (5/5): python-sphinx-0.6.6-2.el6.noarch.rpm              | 486 kB     00:02  \r
80 ---------------------------------------------------------------------------\r
81 Total                                           200 kB/s | 3.2 MB     00:16\r
82 \r
83 (python-docutils were already installed)\r
84 I wonder how hard it is to install these on some systems...\r
85 \r
86 >\r
87 >  doc/Makefile                 | 177 ++++++++++++++++++++++++++++\r
88 >  doc/conf.py                  | 272 +++++++++++++++++++++++++++++++++++++++++++\r
89 >  doc/index.rst                |  24 ++++\r
90 >  doc/notmuch-emacs.rst        | 188 ++++++++++++++++++++++++++++++\r
91 >  doc/notmuch-search-terms.rst | 255 ++++++++++++++++++++++++++++++++++++++++\r
92 >  doc/notmuch-search.rst       | 203 ++++++++++++++++++++++++++++++++\r
93 >  doc/notmuch.rst              | 173 +++++++++++++++++++++++++++\r
94 >  7 files changed, 1292 insertions(+)\r
95 >  create mode 100644 doc/Makefile\r
96 >  create mode 100644 doc/conf.py\r
97 >  create mode 100644 doc/index.rst\r
98 >  create mode 100644 doc/notmuch-emacs.rst\r
99 >  create mode 100644 doc/notmuch-search-terms.rst\r
100 >  create mode 100644 doc/notmuch-search.rst\r
101 >  create mode 100644 doc/notmuch.rst\r
102 >\r