Skip to content

Conversation

@hugovk
Copy link
Member

(cherry picked from commit 8647ba4)

Remove the exclamation mark from :program:`!foo` in .rst files because it inadvertently shows up in the rendered HTML. (Sphinx's cross-referencing roles use a '!' prefix to suppress hyperlinking[1], but :program: is not a cross-referencing role so the '!' is displayed verbatim.) The exclamation marks in venv.rst were introduced in pythonGH-98350. See comments [2] and [3] for additional discussion. [1]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.htmlGH-cross-referencing-syntax [2]: https://github.com/python/cpython/pull/98350GH-issuecomment-1285965759 [3]: https://github.com/python/cpython/pull/98350GH-issuecomment-1286394047 Reported-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>. (cherry picked from commit 8647ba4) Co-authored-by: Tom Levy <tomlevy93@gmail.com>
@hugovkhugovk requested a review from vsajip as a code ownerMarch 15, 2023 07:15
@bedevere-botbedevere-bot added docs Documentation in the Doc dir skip news labels Mar 15, 2023
@hugovkhugovk merged commit 087fb56 into python:3.10Mar 15, 2023
@hugovkhugovk deleted the backport-8647ba4-3.10 branch March 15, 2023 07:26
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docsDocumentation in the Doc dirskip issueskip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@hugovk@bedevere-bot@tom93