From e2a1be689c87f4bb812e354627b0dbb62165797d Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Sun, 23 Jan 2022 21:35:13 +0000 Subject: [PATCH 1/5] Mention dark mode colour scheme --- pep-0676.rst | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/pep-0676.rst b/pep-0676.rst index b955e1f920a..b19589347fc 100644 --- a/pep-0676.rst +++ b/pep-0676.rst @@ -79,6 +79,7 @@ There are several requests for additional features in reading PEPs, such as: * typographic quotation marks [4]_ * additional footer information [5]_ * intersphinx functionality [6]_ +* dark mode theme [7]_ These are "easy wins" from this proposal, and would serve to improve the quality-of-life for consumers of PEPs (including reviewers and writers). @@ -88,7 +89,7 @@ schedule. This means that updates to PEPs cannot be circulated immediately, reducing productivity. The reference implementation renders and publishes all PEPs on every commit to the repository, solving the issue by design. -The reference implementation fixes several issues [7]_. For example: +The reference implementation fixes several issues [8]_. For example: * list styles are currently not respected by `python.org`_'s stylesheets * support for updating images in PEPs is challenging in `python.org`_ @@ -168,8 +169,8 @@ Reference Implementation ======================== The proposed implementation has been merged into the `python/peps`_ repository -in a series of pull requests [8]_. It uses the `Sphinx`_ documentation system -with a custom theme and extensions. +in a series of pull requests [9]_. It uses the `Sphinx`_ documentation system +with a custom theme (supporting normal and dark colour schemes) and extensions. This already automatically renders all PEPs on every commit, and publishes them to `python.github.io/peps`_. @@ -233,11 +234,12 @@ Footnotes .. [4] Requested: `peps#165 `__ .. [5] Requested: `pythondotorg#1564 `__ .. [6] Requested: `comment in peps#2 `__ -.. [7] As of November 2021, see +.. [7] Requested: `in python-dev `__ +.. [8] As of November 2021, see `peps#1387 `__, `pythondotorg#824 `__, `pythondotorg#1556 `__, -.. [8] Implementation PRs: +.. [9] Implementation PRs: `peps#1930 `__, `peps#1931 `__, `peps#1932 `__, From 54f11c27a2689f777ee1c4ec32fca82f0ad781f2 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Sun, 23 Jan 2022 21:44:01 +0000 Subject: [PATCH 2/5] Link to documentation --- pep-0676.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/pep-0676.rst b/pep-0676.rst index b19589347fc..d642f1492d3 100644 --- a/pep-0676.rst +++ b/pep-0676.rst @@ -173,7 +173,9 @@ in a series of pull requests [9]_. It uses the `Sphinx`_ documentation system with a custom theme (supporting normal and dark colour schemes) and extensions. This already automatically renders all PEPs on every commit, and publishes them -to `python.github.io/peps`_. +to `python.github.io/peps`_. The high level documentation for the system covers +:doc:`how to render PEPs locally ` and +:doc:`the implementation of the system ` Rejected Ideas From 46c945105c4e9579e77fa11d6edd1d5e6a053e13 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Sun, 23 Jan 2022 21:44:25 +0000 Subject: [PATCH 3/5] Add myself to CODEOWNERS --- .github/CODEOWNERS | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 0fe9b3915be..86953310027 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -550,7 +550,7 @@ pep-0672.rst @encukou pep-0673.rst @jellezijlstra pep-0674.rst @vstinner pep-0675.rst @jellezijlstra -pep-0676.rst @Mariatta +pep-0676.rst @AA-Turner @Mariatta pep-0677.rst @gvanrossum pep-0678.rst @iritkatriel pep-0679.rst @pablogsal From 75b5f36a658ed7222203cab55529366926e23934 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Sun, 23 Jan 2022 21:55:24 +0000 Subject: [PATCH 4/5] Use anonymous reference targets --- pep-0676.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pep-0676.rst b/pep-0676.rst index d642f1492d3..949bd289c5b 100644 --- a/pep-0676.rst +++ b/pep-0676.rst @@ -174,8 +174,8 @@ with a custom theme (supporting normal and dark colour schemes) and extensions. This already automatically renders all PEPs on every commit, and publishes them to `python.github.io/peps`_. The high level documentation for the system covers -:doc:`how to render PEPs locally ` and -:doc:`the implementation of the system ` +`how to render PEPs locally `__ and +`the implementation of the system `__. Rejected Ideas From 120d23b600267baf71b7ffe9e1f457a33955ed97 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Sun, 23 Jan 2022 22:07:37 +0000 Subject: [PATCH 5/5] Wordsmithing Co-authored-by: Hugo van Kemenade --- pep-0676.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pep-0676.rst b/pep-0676.rst index 949bd289c5b..957bd113dd1 100644 --- a/pep-0676.rst +++ b/pep-0676.rst @@ -170,7 +170,7 @@ Reference Implementation The proposed implementation has been merged into the `python/peps`_ repository in a series of pull requests [9]_. It uses the `Sphinx`_ documentation system -with a custom theme (supporting normal and dark colour schemes) and extensions. +with a custom theme (supporting light and dark colour schemes) and extensions. This already automatically renders all PEPs on every commit, and publishes them to `python.github.io/peps`_. The high level documentation for the system covers