From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from localhost (localhost [127.0.0.1]) by arlo.cworth.org (Postfix) with ESMTP id AF8316DE12A7 for ; Sun, 13 Aug 2017 23:37:15 -0700 (PDT) X-Virus-Scanned: Debian amavisd-new at cworth.org X-Spam-Flag: NO X-Spam-Score: 0.026 X-Spam-Level: X-Spam-Status: No, score=0.026 tagged_above=-999 required=5 tests=[AWL=-0.204, FREEMAIL_FORGED_FROMDOMAIN=0.249, FREEMAIL_FROM=0.001, HEADER_FROM_DIFFERENT_DOMAINS=0.001, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, SPF_PASS=-0.001] 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 YFTuHlUUNfbb for ; Sun, 13 Aug 2017 23:37:14 -0700 (PDT) Received: from mail-wm0-f42.google.com (mail-wm0-f42.google.com [74.125.82.42]) by arlo.cworth.org (Postfix) with ESMTPS id 312196DE129E for ; Sun, 13 Aug 2017 23:37:14 -0700 (PDT) Received: by mail-wm0-f42.google.com with SMTP id m85so30441967wma.0 for ; Sun, 13 Aug 2017 23:37:13 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=X1QpVilJo5Btc9DWq1VWwtSxaT4O9bA/gP7BjrTyDLQ=; b=Rcgbr/arYobPixjk1xT62Qc7gNihhN/lfY9hvnFB9yCrDHcMntcCdi41RUldKUyhQ8 ZLWYGTQXbmBUh0MfxVXlPeTiLSIK+2BwahrzYqw8UTHcPd1RSLHiNN0NDFYOTogWwbW6 CRhx0mSmJwrBz3mvI6VAHNRTpuJD8vuoyaVh3a/u5AsrhhHYizN2tbDJ0LG4D3/Vc4l3 cg9r8TWrFDwDgXc+U7/SK4szL2nTl+UXLA7XQ7uNqda2M3s27uzxYCCNo3HXfhG+BSwI vAr9YVLXTeVemnl7Jn9QsAy/2OgkOisXY/PVRBnj5yF3vDoYd+23HOyZ8pYmwtz1vnGy Ujmw== X-Gm-Message-State: AHYfb5hj9ne0Cxklt58KcTmbG9MYXrG+zGywaS0MUxLJ4KepS5V2L44p GBhx5mz8dGn7GAg7do4= X-Received: by 10.28.50.65 with SMTP id y62mr3186587wmy.8.1502692632132; Sun, 13 Aug 2017 23:37:12 -0700 (PDT) Received: from home.thecybershadow.net ([89.28.117.31]) by smtp.gmail.com with ESMTPSA id u128sm3262545wmu.29.2017.08.13.23.37.10 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Sun, 13 Aug 2017 23:37:11 -0700 (PDT) From: Vladimir Panteleev To: notmuch@notmuchmail.org Cc: Vladimir Panteleev Subject: [PATCH] doc: Disable SmartyPants in generated manual pages Date: Mon, 14 Aug 2017 06:36:54 +0000 Message-Id: <20170814063654.17157-1-git@thecybershadow.net> X-Mailer: git-send-email 2.13.3 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: notmuch@notmuchmail.org X-Mailman-Version: 2.1.23 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, 14 Aug 2017 06:37:15 -0000 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=<*filename*>] got turned into: notmuch tag –batch [–input=] 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. * 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 = [] # Output file base name for HTML help builder. htmlhelp_basename = 'notmuchdoc' +# Disable SmartyPants, as it mangles command lines. +# Despite the name, this actually affects manual pages as well. +html_use_smartypants = False + # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples -- 2.13.3