File tree 2 files changed +17
-3
lines changed 2 files changed +17
-3
lines changed Original file line number Diff line number Diff line change 173
173
# using the given strftime format.
174
174
html_last_updated_fmt = '%b %d, %Y'
175
175
176
- # If true, SmartyPants will be used to convert quotes and dashes to
177
- # typographically correct entities.
178
- smart_quotes = False
176
+ # If true, the Docutils Smart Quotes transform (originally based on
177
+ # SmartyPants) will be used to convert characters like quotes and dashes
178
+ # to typographically correct entities. The default is True.
179
+ smartquotes = True
180
+
181
+ # This string, for use with Docutils 0.14 or later, customizes the
182
+ # SmartQuotes transform. The default of "qDe" converts normal quote
183
+ # characters ('"' and "'"), en and em dashes ("--" and "---"), and
184
+ # ellipses "...".
185
+ # For now, we disable the conversion of dashes so that long options
186
+ # like "--find-links" won't render as "-find-links" if included in the
187
+ # text in places where monospaced type can't be used. For example, backticks
188
+ # can't be used inside roles like :ref:`--no-index <--no-index>` because
189
+ # of nesting.
190
+ smartquotes_action = "qe"
179
191
180
192
# Custom sidebar templates, maps document names to template names.
181
193
html_sidebars = {
Original file line number Diff line number Diff line change
1
+ Make dashes render correctly when displaying long options like
2
+ ``--find-links`` in the text.
You can’t perform that action at this time.
0 commit comments