8000 Infra: Add directives to show warning banner for deprecated PEPs by hugovk · Pull Request #3682 · python/peps · GitHub
[go: up one dir, main page]
Skip to content

Infra: Add directives to show wa 8000 rning banner for deprecated PEPs #3682

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.

Sign up for GitHub

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

Merged
merged 20 commits into from
Apr 14, 2024
Merged

Infra: Add directives to show warning banner for deprecated PEPs #3682

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
754db5e
Add directives to show warning banner for deprecated PEPs
hugovk Feb 18, 2024
d5cf328
Apply directives
hugovk Feb 18, 2024
20ed22a
Add directive to show warning banner for superseded PEP
hugovk Feb 22, 2024
e5f451f
Apply directive
hugovk Feb 22, 2024
87ea181
Remove redundant Abandoned directive
hugovk Feb 26, 2024
78b0634
Include "This PEP has been superseded by PEP xxx" in directive template
hugovk Feb 27, 2024
ac2c015
PEP 3: Intro section is withdrawal notice
hugovk Feb 27, 2024
efd0955
PEP 3: ... and de-duplicate
hugovk Feb 27, 2024
48cb093
PEP 42: update links
hugovk Feb 27, 2024
2e41ad9
PEP 216: rejection by author is really withdrawal
hugovk Feb 27, 2024
c131de6
PEP 216: rejection by author is really withdrawal
hugovk Feb 27, 2024
08fbdec
PEP 224: Add reference to rejection section
hugovk Feb 27, 2024
ccd3192
PEP 224: Fix reference and link from banner
hugovk Feb 27, 2024
ec983b0
PEP 239: Fix banner text
hugovk Feb 27, 2024
5169af7
PEP 242: rejection by author is really withdrawal
hugovk Feb 27, 2024
aba6113
PEP 426: first section is withdrawal notice
hugovk Feb 27, 2024
5cb05c2
PEP 363: link to rejection discussion from banner
hugovk Feb 27, 2024
6d3e572
PEP 426: ... and de-duplicate hugovk Feb 27, 2024
afa418d
Move common directive logic into a subclass
hugovk Feb 27, 2024
f56fcd9
Merge branch 'main' into deprecated-directives
hugovk Apr 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions pep_sphinx_extensions/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,10 @@ def setup(app: Sphinx) -> dict[str, bool]:
"canonical-pypa-spec", pep_banner_directive.CanonicalPyPASpecBanner)
app.add_directive(
"canonical-typing-spec", pep_banner_directive.CanonicalTypingSpecBanner)
app.add_directive("abandoned", pep_banner_directive.AbandonedBanner)
app.add_directive("rejected", pep_banner_directive.RejectedBanner)
app.add_directive("superseded", pep_banner_directive.SupersededBanner)
app.add_directive("withdrawn", pep_banner_directive.WithdrawnBanner)

# Register event callbacks
app.connect("builder-inited", _update_config_for_builder) # Update configuration values for builder used
Expand Down
36 changes: 36 additions & 0 deletions pep_sphinx_extensions/pep_processor/parsing/pep_banner_directive.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,3 +125,39 @@ class CanonicalTypingSpecBanner(PEPBanner):
admonition_class = nodes.attention

css_classes = ["canonical-typing-spec", "sticky-banner"]


class AbandonedBanner(PEPBanner):
"""Insert an admonition for abandoned PEPs."""

admonition_class = nodes.warning
admonition_pre_template = "{link_content}"
admonition_pre_text = "This PEP has been abandoned."
css_classes = ["sticky-banner", "deprecated", "abandoned"]


class RejectedBanner(PEPBanner):
"""Insert an admonition for rejected PEPs."""

admonition_class = nodes.warning
admonition_pre_template = "{link_content}"
admonition_pre_text = "This PEP has been rejected."
css_classes = ["sticky-banner", "deprecated", "rejected"]


class SupersededBanner(PEPBanner):
"""Insert an admonition for superseded PEPs."""

admonition_class = nodes.warning
admonition_pre_template = "{link_content}"
admonition_pre_text = "This PEP has been superseded."
css_classes = ["sticky-banner", "deprecated", "superseded"]


class WithdrawnBanner(PEPBanner):
"""Insert an admonition for withdrawn PEPs."""

admonition_class = nodes.warning
admonition_pre_template = "{link_content}"
admonition_pre_text = "This PEP has been withdrawn."
css_classes = ["sticky-banner", "deprecated", "withdrawn"]
2 changes: 1 addition & 1 deletion peps/pep-0003.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ Title: Guidelines for Handling Bug Reports
Author: Jeremy Hylton <jeremy@alum.mit.edu>
Status: Withdrawn
Type: Process
Content-Type: text/x-rst
Created: 25-Sep-2000
Post-History:

.. withdrawn::

Introduction
============
Expand Down
26 changes: 5 additions & 21 deletions peps/pep-0009.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,20 @@
PEP: 9
Title: Sample Plaintext PEP Template
Version: $Revision$
Last-Modified: $Date$
Author: Barry Warsaw <barry@python.org>
Status: Withdrawn
Type: Process
Content-Type: text/x-rst
Created: 14-Aug-2001
Post-History:
Resolution: https://mail.python.org/archives/list/python-dev@python.org/thread/2YMHVPRDWGQLA5A2FKXE2JMLM2HQEEGW/

.. withdrawn::
As of 05-Jan-2016, this PEP is officially deprecated and replaced
by :pep:`12`. All PEPs should now use the reStructuredText format
described by :pep:`12`, and plaintext PEPs will no longer be
accepted.

::

Update

As of 05-Jan-2016, this PEP is officially deprecated and replaced
by PEP 12. All PEPs should now use the reStructuredText format
described by PEP 12, and plaintext PEPs will no longer be
accepted.

Abstract

This PEP provides a boilerplate or sample template for creating
Expand Down Expand Up @@ -225,14 +220,3 @@ Resolution: https://mail.python.org/archives/list/python-dev@python.org/thread/2
Copyright

This document has been placed in the public domain.



..
Local Variables:
mode: indented-text
indent-tabs-mode: nil
sentence-end-double-space: t
fill-column: 70
coding: utf-8
End:
14 changes: 2 additions & 12 deletions peps/pep-0042.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
PEP: 42
Title: Feature Requests
Version: $Revision$
Last-Modified: $Date$
Author: Jeremy Hylton <jeremy@alum.mit.edu>
Status: Withdrawn
Type: Process
Content-Type: text/x-rst
Created: 12-Sep-2000
Post-History:


.. note:: This PEP has been `withdrawn as obsolete`_.
.. withdrawn::
This PEP has been `withdrawn as obsolete`_.
All new feature requests should either go to the `Python bug tracker`_
for very simple requests or the `python-ideas`_ mailing list for
everything else. The rest of this document is retained for historical
Expand Down Expand Up @@ -335,10 +332,3 @@ Building and Installing
.. _`Python bug tracker`: https://bugs.python.org
.. _`python-ideas`: https://mail.python.org/mailman/listinfo/python-ideas
.. _`withdrawn as obsolete`: https://github.com/python/peps/pull/108#issuecomment-249603204


..
Local Variables:
mode: indented-text
indent-tabs-mode: nil
End:
29 changes: 6 additions & 23 deletions peps/pep-0103.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,19 @@
PEP: 103
Title: Collecting information about git
Version: $Revision$
Last-Modified: $Date$
Author: Oleg Broytman <phd@phdru.name>
Status: Withdrawn
Type: Informational
Content-Type: text/x-rst
Created: 01-Jun-2015
Post-History: 12-Sep-2015

Withdrawal
==========
.. withdrawn::
This PEP was withdrawn as it's too generic and doesn't really deals
with Python development. It is no longer updated.

This PEP was withdrawn as it's too generic and doesn't really deals
with Python development. It is no longer updated.
The content was moved to `Python Wiki`_. Make further updates in the
wiki.

The content was moved to `Python Wiki`_. Make further updates in the
wiki.

.. _`Python Wiki`: https://wiki.python.org/moin/Git
.. _`Python Wiki`: https://wiki.python.org/moin/Git

Abstract
========
Expand Down Expand Up @@ -1076,15 +1071,3 @@ Copyright
=========

This document has been placed in the public domain.



..
Local Variables:
mode: indented-text
indent-tabs-mode: nil
sentence-end-double-space: t
fill-column: 70
coding: utf-8
End:
vim: set fenc=us-ascii tw=70 :
27 changes: 11 additions & 16 deletions peps/pep-0204.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,21 @@ Title: Range Literals
Author: Thomas Wouters <thomas@python.org>
Status: Rejected
Type: Standards Track
Content-Type: text/x-rst
Created: 14-Jul-2000
Python-Version: 2.0
Post-History:

.. rejected::
After careful consideration, and a period of meditation, this
proposal has been rejected. The open issues, as well as some
confusion between ranges and slice syntax, raised enough questions
for Guido not to accept it for Python 2.0, and later to reject the
proposal altogether. The new syntax and its intentions were deemed
not obvious enough.

[ TBD: Guido, amend/confirm this, please. Preferably both; this
is a PEP, it should contain *all* the reasons for rejection
and/or reconsideration, for future reference. ]

Introduction
============
Expand Down Expand Up @@ -270,21 +280,6 @@ Open issues
made private functions?


Rejection
=========

After careful consideration, and a period of meditation, this
proposal has been rejected. The open issues, as well as some
confusion between ranges and slice syntax, raised enough questions
for Guido not to accept it for Python 2.0, and later to reject the
proposal altogether. The new syntax and its intentions were deemed
not obvious enough.

[ TBD: Guido, amend/confirm this, please. Preferably both; this
is a PEP, it should contain *all* the reasons for rejection
and/or reconsideration, for future reference. ]


Copyright
=========

Expand Down
11 changes: 1 addition & 10 deletions peps/pep-0206.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
PEP: 206
Title: Python Advanced Library
Version: $Revision$
Last-Modified: $Date$
Author: A.M. Kuchling <amk@amk.ca>
Status: Withdrawn
Type: Informational
Content-Type: text/x-rst
Created: 14-Jul-2000
Post-History:

.. withdrawn::

Introduction
============
Expand Down Expand Up @@ -119,10 +117,3 @@ Acknowledgements

The PEP is based on an earlier draft PEP by Moshe Zadka, titled
"2.0 Batteries Included."


..
Local Variables:
mode: indented-text
indent-tabs-mode: nil
End:
2 changes: 1 addition & 1 deletion peps/pep-0209.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ Title: Multi-dimensional Arrays
Author: Paul Barrett <barrett@stsci.edu>, Travis Oliphant <oliphant@ee.byu.edu>
Status: Withdrawn
Type: Standards Track
Content-Type: text/x-rst
Created: 03-Jan-2001
Python-Version: 2.2
Post-History:

.. withdrawn::

Abstract
========
Expand Down
9 changes: 1 addition & 8 deletions peps/pep-0210.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,8 @@ Title: Decoupling the Interpreter Loop
Author: David Ascher <davida@activestate.com>
Status: Rejected
Type: Standards Track
Content-Type: text/x-rst
Created: 15-Jul-2000
Python-Version: 2.1
Post-History:



..
Local Variables:
mode: indented-text
indent-tabs-mode: nil
End:
.. rejected::
4 changes: 1 addition & 3 deletions peps/pep-0211.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,12 @@ Title: Adding A New Outer Product Operator
Author: Greg Wilson <gvwilson@ddj.com>
Status: Rejected
Type: Standards Track
Content-Type: text/x-rst
Created: 15-Jul-2000
Python-Version: 2.1
Post-History:


.. note::

.. rejected::
The approach in the later :pep:`465` was eventually accepted
in lieu of this PEP. The :pep:`Rejected Ideas
<465#rejected-alternatives-to-adding-a-new-operator>`
Expand Down
2 changes: 1 addition & 1 deletion peps/pep-0215.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ Title: String Interpolation
Author: Ka-Ping Yee <ping@zesty.ca>
Status: Superseded
Type: Standards Track
Content-Type: text/x-rst
Created: 24-Jul-2000
Python-Version: 2.1
Post-History:
Superseded-By: 292

.. superseded:: Superseded by :pep:`292`

Abstract
========
Expand Down
8 changes: 2 additions & 6 deletions peps/pep-0216.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,13 @@ Title: Docstring Format
Author: Moshe Zadka <moshez@zadka.site.co.il>
Status: Rejected
Type: Informational
Content-Type: text/x-rst
Created: 31-Jul-2000
Post-History:
Superseded-By: 287


Notice
======

This PEP is rejected by the author. It has been superseded by PEP
287.
.. rejected::
This PEP is rejected by the author. It has been superseded by :pep:`287`.


Abstract
Expand Down
2 changes: 1 addition & 1 deletion peps/pep-0220.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ Title: Coroutines, Generators, Continuations
Author: Gordon McMillan <gmcm@hypernet.com>
Status: Rejected
Type: Informational
Content-Type: text/x-rst
Created: 14-Aug-2000
Post-History:

.. rejected::

Abstract
========
Expand Down
2 changes: 1 addition & 1 deletion peps/pep-0224.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ Title: Attribute Docstrings
Author: Marc-André Lemburg <mal@lemburg.com>
Status: Rejected
Type: Standards Track
Content-Type: text/x-rst
Created: 23-Aug-2000
Python-Version: 2.1
Post-History:

.. rejected::

Introduction
============
Expand Down
4 changes: 1 addition & 3 deletions peps/pep-0225.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,12 @@ Author: Huaiyu Zhu <hzhu@users.sourceforge.net>,
Gregory Lielens <gregory.lielens@fft.be>
Status: Rejected
Type: Standards Track
Content-Type: text/x-rst
Created: 19-Sep-2000
Python-Version: 2.1
Post-History:


.. note::

.. rejected::
The approach in the later :pep:`465` was eventually accepted
in lieu of this PEP. The :pep:`Rejected Ideas
<465#rejected-alternatives-to-adding-a-new-operator>`
Expand Down
Loading
0