8000 PEP 0, 1, 12: Update meta-PEPs to exemplify the current link guidance · python/peps@42e7d3b · GitHub
[go: up one dir, main page]

Skip to content

Commit 42e7d3b

Browse files
committed
PEP 0, 1, 12: Update meta-PEPs to exemplify the current link guidance
1 parent b7a0aaa commit 42e7d3b

File tree

3 files changed

+19
-21
lines changed

3 files changed

+19
-21
lines changed

pep-0001.txt

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -423,7 +423,6 @@ to development practices and other details. The precise process followed in
423423
these cases will depend on the nature and purpose of the PEP being updated.
424424

425425

426-
427426
What belongs in a successful PEP?
428427
=================================
429428

@@ -785,18 +784,16 @@ Footnotes
785784
=========
786785

787786
.. [1] This historical record is available by the normal git commands
788-
for retrieving older revisions, and can also be browsed via HTTP here:
789-
https://github.com/python/peps
787+
for retrieving older revisions, and can also be browsed
788+
`on GitHub <https://github.com/python/peps>`__.
790789

791790
.. [2] More details on the PEP rendering and publication process can be found
792-
in the PEPs repo README at
793-
https://github.com/python/peps/blob/main/README.rst
791+
in the `PEPs repo README
792+
<https://github.com/python/peps/blob/main/README.rst>`__.
794793

795-
.. _.github/CODEOWNERS:
796-
https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
794+
.. _.github/CODEOWNERS: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
797795

798-
.. _issue tracker:
799-
https://bugs.python.org/
796+
.. _issue tracker: https://bugs.python.org/
800797

801798
.. _CC0-1.0-Universal: https://choosealicense.com/licenses/cc0-1.0/
802799

pep-0012.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,9 @@ Note: if you are reading this PEP via the web, you should first grab
2626
the text (reStructuredText) source of this PEP in order to complete
2727
the steps below. **DO NOT USE THE HTML FILE AS YOUR TEMPLATE!**
2828

29-
The source for this (or any) PEP can be found in the PEPs repository,
30-
viewable on the web at https://github.com/python/peps/ .
29+
The source for this (or any) PEP can be found in the
30+
`PEPs repository <https://github.com/python/peps/>`_,
31+
as well as via a link at the bottom of each PEP.
3132

3233

3334
Rationale
@@ -680,27 +681,27 @@ thoroughness, please see:
680681

681682
* `A ReStructuredText Primer`__, a gentle introduction.
682683

683-
__ http://docutils.sourceforge.net/docs/rst/quickstart.html
684+
__ https://docutils.sourceforge.io/docs/user/rst/quickstart.html
684685

685686
* `Quick reStructuredText`__, a users' quick reference.
686687

687-
__ http://docutils.sourceforge.net/docs/rst/quickref.html
688+
__ https://docutils.sourceforge.io/docs/user/rst/quickref.html
688689

689690
* `reStructuredText Markup Specification`__, the final authority.
690691

691-
__ http://docutils.sourceforge.net/spec/rst/reStructuredText.html
692+
__ https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html
692693

693694
The processing of reStructuredText PEPs is done using Docutils_. If
694695
you have a question or require assistance with reStructuredText or
695696
Docutils, please `post a message`_ to the `Docutils-users mailing
696697
list`_. The `Docutils project web site`_ has more information.
697698

698699
.. _Docutils:
699-
.. _Docutils project web site: http://docutils.sourceforge.net/
700+
.. _Docutils project web site: https://docutils.sourceforge.io/
700701
.. _post a message:
701702
mailto:docutils-users@lists.sourceforge.net?subject=PEPs
702703
.. _Docutils-users mailing list:
703-
http://docutils.sf.net/docs/user/mailing-lists.html#docutils-users
704+
https://docutils.sourceforge.io/docs/user/mailing-lists.html#docutils-users
704705

705706

706707
Copyright

pep0/constants.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,14 @@
2121

2222
intro = """\
2323
This PEP contains the index of all Python Enhancement Proposals,
24-
known as PEPs. PEP numbers are assigned by the PEP editors[1_], and
25-
once assigned are never changed. The version control history [2_] of
26-
the PEP texts represent their historical record.
24+
known as PEPs. PEP numbers are :pep:`assigned <1#pep-editors>` by the
25+
PEP editors, and once assigned are never changed.
26+
The `version control history`_ of the PEP texts represent
27+
their historical record.
2728
"""
2829

2930
references = """\
30-
.. [1] PEP 1: PEP Purpose and Guidelines
31-
.. [2] View PEP history online: https://github.com/python/peps
31+
.. _version control history: https://github.com/python/peps
3232
"""
3333

3434
footer = """ \

0 commit comments

Comments
 (0)
0