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 arlo.cworth.org (Postfix) with ESMTP id 32A836DE0C66
 for <notmuch@notmuchmail.org>; Sat, 19 Aug 2017 11:04:19 -0700 (PDT)
X-Virus-Scanned: Debian amavisd-new at cworth.org
X-Spam-Flag: NO
X-Spam-Score: 0.489
X-Spam-Level: 
X-Spam-Status: No, score=0.489 tagged_above=-999 required=5 tests=[AWL=-0.163, 
 SPF_NEUTRAL=0.652] autolearn=disabled
Received: from arlo.cworth.org ([127.0.0.1])
 by localhost (arlo.cworth.org [127.0.0.1]) (amavisd-new, port 10024)
 with ESMTP id b1pcHxRdOX7a for <notmuch@notmuchmail.org>;
 Sat, 19 Aug 2017 11:04:18 -0700 (PDT)
Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34])
 by arlo.cworth.org (Postfix) with ESMTP id E23336DE0C64
 for <notmuch@notmuchmail.org>; Sat, 19 Aug 2017 11:04:17 -0700 (PDT)
Received: from guru.guru-group.fi (localhost [IPv6:::1])
 by guru.guru-group.fi (Postfix) with ESMTP id B7882100090;
 Sat, 19 Aug 2017 21:04:05 +0300 (EEST)
From: Tomi Ollila <tomi.ollila@iki.fi>
To: Vladimir Panteleev <git@thecybershadow.net>, notmuch@notmuchmail.org
Subject: Re: [PATCH] doc: Disable SmartyPants in generated manual pages
In-Reply-To: <20170814063654.17157-1-git@thecybershadow.net>
References: <20170814063654.17157-1-git@thecybershadow.net>
User-Agent: Notmuch/0.25+26~ge420d51 (https://notmuchmail.org) Emacs/25.2.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: Sat, 19 Aug 2017 21:04:05 +0300
Message-ID: <m2shgne8oa.fsf@guru.guru-group.fi>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
X-BeenThere: notmuch@notmuchmail.org
X-Mailman-Version: 2.1.23
Precedence: list
List-Id: "Use and development of the notmuch mail system."
 <notmuch.notmuchmail.org>
List-Unsubscribe: <https://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: <https://notmuchmail.org/mailman/listinfo/notmuch>,
 <mailto:notmuch-request@notmuchmail.org?subject=subscribe>
X-List-Received-Date: Sat, 19 Aug 2017 18:04:19 -0000

On Mon, Aug 14 2017, Vladimir Panteleev wrote:

> By default, Sphinx tries to pre-process text through SmartyPants,
> which attempts to convert ASCII quotes and dashes to Unicode
> characters. Unfortunately, this mangles technical text such as command
> lines. For instance, this excerpt from notmuch-tag.rst:
>
>   **notmuch** **tag** **--batch** [--input=3D<*filename*>]
>
> got turned into:
>
>   notmuch tag =E2=80=93batch [=E2=80=93input=3D<filename>]
>
> That's an en-dash and an em-dash respectively.
>
> Not only are these characters visually confusing and could easily be
> mistaken for a single dash, copying and pasting such command lines
> into a terminal is doomed to result in incomprehensible error
> messages.

I agree. LGTM. works as advertised.

Tomi

>
> * doc/conf.py: Disable SmartyPants.
> ---
>  doc/conf.py | 4 ++++
>  1 file changed, 4 insertions(+)
>
> diff --git a/doc/conf.py b/doc/conf.py
> index aa864b3c..0e65413d 100644
> --- a/doc/conf.py
> +++ b/doc/conf.py
> @@ -47,6 +47,10 @@ html_static_path =3D []
>  # Output file base name for HTML help builder.
>  htmlhelp_basename =3D 'notmuchdoc'
>=20=20
> +# Disable SmartyPants, as it mangles command lines.
> +# Despite the name, this actually affects manual pages as well.
> +html_use_smartypants =3D False
> +
>  # -- Options for manual page output ------------------------------------=
---
>=20=20
>  # One entry per manual page. List of tuples
> --=20
> 2.13.3
>
> _______________________________________________
> notmuch mailing list
> notmuch@notmuchmail.org
> https://notmuchmail.org/mailman/listinfo/notmuch