From ded594572ee267c4afcbb7e7db15bd061322295b Mon Sep 17 00:00:00 2001 From: David Bremner Date: Mon, 20 Jan 2014 14:57:26 +2000 Subject: [PATCH] Re: [RFC Patch] start of sphinx based docs --- e4/be2a00085d76414201275e94bcc5b06ec386ba | 82 +++++++++++++++++++++++ 1 file changed, 82 insertions(+) create mode 100644 e4/be2a00085d76414201275e94bcc5b06ec386ba diff --git a/e4/be2a00085d76414201275e94bcc5b06ec386ba b/e4/be2a00085d76414201275e94bcc5b06ec386ba new file mode 100644 index 000000000..34b07fd53 --- /dev/null +++ b/e4/be2a00085d76414201275e94bcc5b06ec386ba @@ -0,0 +1,82 @@ +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 2BE8B431FC0 + for ; Sun, 19 Jan 2014 10:57:52 -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 C3jn-h9Y9tRA for ; + Sun, 19 Jan 2014 10:57:44 -0800 (PST) +Received: from yantan.tethera.net (yantan.tethera.net [199.188.72.155]) + (using TLSv1 with cipher DHE-RSA-AES128-SHA (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id 4F2C3431FBD + for ; Sun, 19 Jan 2014 10:57:44 -0800 (PST) +Received: from remotemail by yantan.tethera.net with local (Exim 4.80) + (envelope-from ) + id 1W4xYp-0000r9-Gk; Sun, 19 Jan 2014 14:57:31 -0400 +Received: (nullmailer pid 16092 invoked by uid 1000); Sun, 19 Jan 2014 + 18:57:26 -0000 +From: David Bremner +To: Tomi Ollila , notmuch@notmuchmail.org +Subject: Re: [RFC Patch] start of sphinx based docs +In-Reply-To: +References: <1390060858-30905-1-git-send-email-david@tethera.net> + +User-Agent: Notmuch/0.17+35~g3b36898 (http://notmuchmail.org) Emacs/24.3.1 + (x86_64-pc-linux-gnu) +Date: Sun, 19 Jan 2014 14:57:26 -0400 +Message-ID: <87vbxfkdex.fsf@zancas.localnet> +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." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Sun, 19 Jan 2014 18:57:52 -0000 + +Tomi Ollila writes: + +> +> This looks like a good plan, only Makefile & conf.py is a bit noisy +> (like Jani's original Doxyfile) + +That should be easy to fix. Whoevery posted that patch was incredibly +lazy ;). + +> 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... + +It's definitely a concern. We could fall back to python-docutils to +generate the manpages, since there is a standalone rst2man script there. +There are some incompatibilities about how the TH line is generated, but +I think those could be hacked around, if people thought it was worth it. + +d -- 2.26.2