Skip to content

Commit eaae757

Browse files
author
Jonathan Corbet
committed
docs: turn off "smart quotes" in the HTML build
We have long disabled the "html_use_smartypants" option to prevent Sphinx from mangling "--" sequences (among others). Unfortunately, Sphinx changed that option to "smartquotes" in the 1.6.6 release, and seemingly didn't see fit to warn about the use of the obsolete option, resulting in the aforementioned mangling returning. Disable this behavior again and hope that the option name stays stable for a while. Reported-by: Zipeng Zhang <zhangzipeng0@foxmail.com> Link: https://lore.kernel.org/lkml/tencent_CB1A298D31FD221496FF657CD7EF406E6605@qq.com Reviewed-by: Miguel Ojeda <ojeda@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
1 parent b645fc6 commit eaae757

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

Documentation/conf.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -343,9 +343,10 @@ def get_cline_version():
343343
# so a file named "default.css" will overwrite the builtin "default.css".
344344
html_static_path = ['sphinx-static']
345345

346-
# If true, SmartyPants will be used to convert quotes and dashes to
347-
# typographically correct entities.
348-
html_use_smartypants = False
346+
# If true, Docutils "smart quotes" will be used to convert quotes and dashes
347+
# to typographically correct entities. This will convert "--" to "—",
348+
# which is not always what we want, so disable it.
349+
smartquotes = False
349350

350351
# Custom sidebar templates, maps document names to template names.
351352
# Note that the RTD theme ignores this

0 commit comments

Comments
 (0)