Skip to content

[docs] use sphinx :pep: role #6728

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

[docs] use sphinx :pep: role #6728

wants to merge 3 commits into from

Conversation

svenevs
Copy link

@svenevs svenevs commented Apr 26, 2019

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 on latest. 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:

Files (to be) affected:

  • ./docs/source/additional_features.rst
  • ./docs/source/cheat_sheet_py3.rst
  • ./docs/source/cheat_sheet.rst
  • ./docs/source/command_line.rst
  • ./docs/source/faq.rst
  • ./docs/source/generics.rst
  • ./docs/source/getting_started.rst
  • ./docs/source/installed_packages.rst
  • ./docs/source/introduction.rst
  • ./docs/source/kinds_of_types.rst
  • ./docs/source/more_types.rst
  • ./docs/source/protocols.rst
  • ./docs/source/python2.rst
  • ./docs/source/python36.rst
  • ./docs/source/stubgen.rst
  • ./docs/source/stubs.rst

Misc:

  • Keep the latest commit here that adds a linkcheck builder? I added it locally to assist me in addition to manual checking, but maybe this is something mypy will want to keep?

@gvanrossum
Copy link
Member

gvanrossum commented Apr 26, 2019 via email

@hauntsaninja
Copy link
Collaborator

Thanks for bringing this up! I think this has since been subsumed by #7623

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants