From: Mark Walters Date: Mon, 24 Feb 2014 00:54:29 +0000 (+0000) Subject: Re: v3 of sphinx docs X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=270c78eb235d5aad5f8b053abdda6c10f63306be;p=notmuch-archives.git Re: v3 of sphinx docs --- diff --git a/37/c59d60804ce233447d287e34a8674a8e69ae0d b/37/c59d60804ce233447d287e34a8674a8e69ae0d new file mode 100644 index 000000000..2c6b0f783 --- /dev/null +++ b/37/c59d60804ce233447d287e34a8674a8e69ae0d @@ -0,0 +1,112 @@ +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 3D639431FD9 + for ; Sun, 23 Feb 2014 16:54:47 -0800 (PST) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: -1.098 +X-Spam-Level: +X-Spam-Status: No, score=-1.098 tagged_above=-999 required=5 + tests=[DKIM_ADSP_CUSTOM_MED=0.001, FREEMAIL_FROM=0.001, + NML_ADSP_CUSTOM_MED=1.2, RCVD_IN_DNSWL_MED=-2.3] 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 4WpCm433KTEd for ; + Sun, 23 Feb 2014 16:54:42 -0800 (PST) +Received: from mail2.qmul.ac.uk (mail2.qmul.ac.uk [138.37.6.6]) + (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id 07C05431FCF + for ; Sun, 23 Feb 2014 16:54:42 -0800 (PST) +Received: from smtp.qmul.ac.uk ([138.37.6.40]) + by mail2.qmul.ac.uk with esmtp (Exim 4.71) + (envelope-from ) + id 1WHjoV-0005Pd-Lw; Mon, 24 Feb 2014 00:54:35 +0000 +Received: from 93-97-24-31.zone5.bethere.co.uk ([93.97.24.31] helo=localhost) + by smtp.qmul.ac.uk with esmtpsa (TLSv1:AES128-SHA:128) (Exim 4.71) + (envelope-from ) + id 1WHjoV-0007aL-9v; Mon, 24 Feb 2014 00:54:31 +0000 +From: Mark Walters +To: David Bremner , notmuch@notmuchmail.org +Subject: Re: v3 of sphinx docs +In-Reply-To: <1393114575-8756-1-git-send-email-david@tethera.net> +References: <87fvo7btu8.fsf@qmul.ac.uk> + <1393114575-8756-1-git-send-email-david@tethera.net> +User-Agent: Notmuch/0.15.2+562~g339f306 (http://notmuchmail.org) Emacs/23.4.1 + (x86_64-pc-linux-gnu) +Date: Mon, 24 Feb 2014 00:54:29 +0000 +Message-ID: <87r46t49fe.fsf@qmul.ac.uk> +MIME-Version: 1.0 +Content-Type: text/plain; charset=us-ascii +X-Sender-Host-Address: 93.97.24.31 +X-QM-Geographic: According to ripencc, + this message was delivered by a machine in Britain (UK) (GB). +X-QM-SPAM-Info: Sender has good ham record. :) +X-QM-Body-MD5: 09cf700407c068d9a68c84da68427938 (of first 20000 bytes) +X-SpamAssassin-Score: 0.0 +X-SpamAssassin-SpamBar: / +X-SpamAssassin-Report: The QM spam filters have analysed this message to + determine if it is + spam. We require at least 5.0 points to mark a message as spam. + This message scored 0.0 points. Summary of the scoring: + * 0.0 FREEMAIL_FROM Sender email is commonly abused enduser mail + provider * (markwalters1009[at]gmail.com) + * 0.0 AWL AWL: From: address is in the auto white-list +X-QM-Scan-Virus: ClamAV says the message is clean +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: Mon, 24 Feb 2014 00:54:47 -0000 + + +This looks good to me. It will obviously need a little tweaking but I +like it. + +There is some error in the conversion for SYNOPSIS for dump, restore +and tag (which may also have caused the problem for compact?) + +Otherwise there were a small number of oddities in indentation, and a +general reduction in boldness (using underlining instead). (This is on a +standard xterm). One case we might care a little about is the SEE ALSO +section at the end where the underlining rather than bold seems +inconsistent with the rest of my debian manpages. + +Best wishes + +Mark + + + + +On Sun, 23 Feb 2014, David Bremner wrote: +> This version includes a complete conversion of the existing manpages. +> The conversion uses doclifter + custom python code + pandoc. It is +> pretty much fully automated, so I can rebase against changes to the +> nroff source if needed. +> +> On the other hand, it is fully automated, so there are bound to be a +> few rough spots. If there are systematic things, I can fix the +> conversion scripts; one offs can just be added to the series. +> +> It does do a much better job of option indentation than the previous +> version. +> +> I think this is reaching the point where if anybody has any strong +> objections to sphinx (with a fallback to rst2man) for the docs, I'd +> like to hear them. +> +> _______________________________________________ +> notmuch mailing list +> notmuch@notmuchmail.org +> http://notmuchmail.org/mailman/listinfo/notmuch