notmuch/doc
Vladimir Panteleev 938ec0f80c 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.
2017-08-20 08:32:29 -03:00
..
man1 add "notmuch reindex" subcommand 2017-08-01 21:17:47 -04:00
man5 clean up spelling 2016-09-12 08:16:35 -03:00
man7 add "notmuch reindex" subcommand 2017-08-01 21:17:47 -04:00
.gitignore Use rooted paths in .gitignore files 2017-08-18 19:42:35 -03:00
conf.py doc: Disable SmartyPants in generated manual pages 2017-08-20 08:32:29 -03:00
doxygen.cfg Use https instead of http where possible 2016-06-05 08:32:17 -03:00
index.rst add "notmuch reindex" subcommand 2017-08-01 21:17:47 -04:00
INSTALL doc: remove support for rst2man 2015-01-22 08:37:25 +01:00
Makefile doc: convert sphinx based docs 2014-03-09 10:41:08 -03:00
Makefile.local build: only install known man pages 2016-11-17 08:42:23 -04:00
notmuch-emacs.rst doc: fix references in notmuch-emacs.rst 2016-11-17 08:39:04 -04:00