From: Vladimir Panteleev <git@thecybershadow.net>
To: notmuch@notmuchmail.org
Cc: Vladimir Panteleev <git@thecybershadow.net>
Subject: [PATCH] doc: Disable SmartyPants in generated manual pages
Date: Mon, 14 Aug 2017 06:36:54 +0000 [thread overview]
Message-ID: <20170814063654.17157-1-git@thecybershadow.net> (raw)
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=<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.
* 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
next reply other threads:[~2017-08-14 6:37 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-08-14 6:36 Vladimir Panteleev [this message]
2017-08-19 18:04 ` [PATCH] doc: Disable SmartyPants in generated manual pages Tomi Ollila
2017-08-20 12:11 ` David Bremner
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://notmuchmail.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20170814063654.17157-1-git@thecybershadow.net \
--to=git@thecybershadow.net \
--cc=notmuch@notmuchmail.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://yhetil.org/notmuch.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).