Skip to content

Commit fe25625

Browse files
akiyksJonathan Corbet
authored andcommitted
docs: Restore "smart quotes" for quotes
Commit eaae757 ("docs: turn off "smart quotes" in the HTML build") disabled conversion of quote marks along with that of dashes. Despite the short summary, the change affects not only HTML build but also other build targets including PDF. However, as "smart quotes" had been enabled for more than half a decade already, quite a few readers of HTML pages are likely expecting conversions of "foo" -> “foo” and 'bar' -> ‘bar’. Furthermore, in LaTeX typesetting convention, it is common to use distinct marks for opening and closing quote marks. To satisfy such readers' expectation, restore conversion of quotes only by setting smartquotes_action [1]. Link: [1] https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-smartquotes_action Cc: [email protected] # v6.4 Signed-off-by: Akira Yokosawa <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
1 parent b1a5455 commit fe25625

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

Documentation/conf.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -346,9 +346,9 @@ def get_cline_version():
346346
html_static_path = ['sphinx-static']
347347

348348
# If true, Docutils "smart quotes" will be used to convert quotes and dashes
349-
# to typographically correct entities. This will convert "--" to "—",
350-
# which is not always what we want, so disable it.
351-
smartquotes = False
349+
# to typographically correct entities. However, conversion of "--" to "—"
350+
# is not always what we want, so enable only quotes.
351+
smartquotes_action = 'q'
352352

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

0 commit comments

Comments
 (0)