[docs] use sphinx :pep: role #6728
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Sphinx
:pep:
role can replace many of the manual links in the docs. It's been around since v1.0 (current docs require Sphinx>=1.4.4).Would you all like me to finish replacing the rest of them? I noticed a broken PEP link on current
stable
docs, which is already fixed onlatest
. Using the:pep:
may help prevent that in the future (not that it happens all that often...).Note: there is a subtle difference, the hyperlink text becomes bold. Simulated:
:pep:
role: PEP 498Files (to be) affected:
Misc:
linkcheck
builder? I added it locally to assist me in addition to manual checking, but maybe this is something mypy will want to keep?