doc: Disable SmartyPants in generated manual pages
authorVladimir Panteleev <git@thecybershadow.net>
Mon, 14 Aug 2017 06:36:54 +0000 (06:36 +0000)
committerDavid Bremner <david@tethera.net>
Sun, 20 Aug 2017 11:32:29 +0000 (08:32 -0300)
commit938ec0f80c0a1cd497b95db8c0d0afdf01c740e8
tree46ba74c51ac9ff0077f6ad06efb78681b0fff370
parentcb5253578d983471e5b55604581d390fcdda38f4
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.
doc/conf.py