McSinyx
/
pip
mirror of https://github.com/pypa/pip
1
1
Fork 0
Code Issues Releases Activity

Fix option name for smart quotes in sphinxdoc conf (#6422) 

Also configure the smartquotes_action to exclude dashes from transformation.
See https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-smartquotes
This commit is contained in:
Albert Tugushev 2019-04-21 23:51:42 +07:00 committed by Chris Jerdonek
parent 1ef8857b4d
commit 7130b1d0e0
2 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/html/conf.py
View File

@ -173,9 +173,21 @@ html_static_path = []
# using the given strftime format.
html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
smart_quotes = False
# If true, the Docutils Smart Quotes transform (originally based on
# SmartyPants) will be used to convert characters like quotes and dashes
# to typographically correct entities. The default is True.
smartquotes = True
# This string, for use with Docutils 0.14 or later, customizes the
# SmartQuotes transform. The default of "qDe" converts normal quote
# characters ('"' and "'"), en and em dashes ("--" and "---"), and
# ellipses "...".
# For now, we disable the conversion of dashes so that long options
# like "--find-links" won't render as "-find-links" if included in the
# text in places where monospaced type can't be used. For example, backticks
# can't be used inside roles like :ref:`--no-index <--no-index>` because
# of nesting.
smartquotes_action = "qe"
# Custom sidebar templates, maps document names to template names.
html_sidebars = {

2
news/6422.doc Normal file
View File

@ -0,0 +1,2 @@
Make dashes render correctly when displaying long options like
``--find-links`` in the text.