diff options
| author | Vladimir Panteleev <git@thecybershadow.net> | 2017-08-14 06:36:54 +0000 |
|---|---|---|
| committer | David Bremner <david@tethera.net> | 2017-08-20 08:32:29 -0300 |
| commit | 938ec0f80c0a1cd497b95db8c0d0afdf01c740e8 (patch) | |
| tree | 46ba74c51ac9ff0077f6ad06efb78681b0fff370 /doc/conf.py | |
| parent | cb5253578d983471e5b55604581d390fcdda38f4 (diff) | |
doc: Disable SmartyPants in generated manual pages
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.
Diffstat (limited to 'doc/conf.py')
| -rw-r--r-- | doc/conf.py | 4 |
1 files changed, 4 insertions, 0 deletions
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 |