From 50f64dd4ad69d46926ed09d7d4bf3d2181ef870c Mon Sep 17 00:00:00 2001
From: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Date: Thu, 13 Jan 2022 18:37:52 +0000
Subject: [PATCH 06/30] Update footer logic, add bottom horizontal rule
---
.../pep_processor/transforms/pep_footer.py | 16 ++++++++++++----
1 file changed, 12 insertions(+), 4 deletions(-)
diff --git a/pep_sphinx_extensions/pep_processor/transforms/pep_footer.py b/pep_sphinx_extensions/pep_processor/transforms/pep_footer.py
index 1f907dfb701..7f8c0f01535 100644
--- a/pep_sphinx_extensions/pep_processor/transforms/pep_footer.py
+++ b/pep_sphinx_extensions/pep_processor/transforms/pep_footer.py
@@ -18,8 +18,8 @@ class PEPFooter(transforms.Transform):
"""
- # Set low priority so ref targets aren't removed before they are needed
- default_priority = 999
+ # Uses same priority as docutils.transforms.TargetNotes
+ default_priority = 520
def apply(self) -> None:
pep_source_path = Path(self.document["source"])
@@ -34,13 +34,21 @@ def apply(self) -> None:
if "references" in title_words:
# Remove references section if there are no displayed
# footnotes (it only has title & link target nodes)
- if all(isinstance(ref_node, (nodes.title, nodes.target))
- for ref_node in section):
+ to_hoist = []
+ types = set()
+ for node in section:
+ types.add(type(node))
+ if isinstance(node, nodes.target):
+ to_hoist.append(node)
+ if types <= {nodes.title, nodes.target}:
+ section.parent.extend(to_hoist)
section.parent.remove(section)
break
# Add link to source text and last modified date
if pep_source_path.stem != "pep-0000":
+ if pep_source_path.stem != "pep-0210": # 210 is entirely empty, skip
+ self.document += nodes.transition()
self.document += _add_source_link(pep_source_path)
self.document += _add_commit_history_info(pep_source_path)
From db5a86b6debb65c0d1ef186b316f0082396e471f Mon Sep 17 00:00:00 2001
From: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Date: Fri, 14 Jan 2022 03:41:25 +0000
Subject: [PATCH 07/30] Clean up extension initialisation
---
pep_sphinx_extensions/__init__.py | 9 +++++++--
1 file changed, 7 insertions(+), 2 deletions(-)
diff --git a/pep_sphinx_extensions/__init__.py b/pep_sphinx_extensions/__init__.py
index f302b14b7b9..d6b459d2320 100644
--- a/pep_sphinx_extensions/__init__.py
+++ b/pep_sphinx_extensions/__init__.py
@@ -50,12 +50,17 @@ def setup(app: Sphinx) -> dict[str, bool]:
# Register plugin logic
app.add_builder(pep_html_builder.FileBuilder, override=True)
app.add_builder(pep_html_builder.DirectoryBuilder, override=True)
+
app.add_source_parser(pep_parser.PEPParser) # Add PEP transforms
- app.add_role("pep", pep_role.PEPRole(), override=True) # Transform PEP references to links
+
app.set_translator("html", pep_html_translator.PEPTranslator) # Docutils Node Visitor overrides (html builder)
app.set_translator("dirhtml", pep_html_translator.PEPTranslator) # Docutils Node Visitor overrides (dirhtml builder)
- app.connect("env-before-read-docs", create_pep_zero) # PEP 0 hook
+
+ app.add_role("pep", pep_role.PEPRole(), override=True) # Transform PEP references to links
+
+ # Register event callbacks
app.connect("builder-inited", _update_config_for_builder) # Update configuration values for builder used
+ app.connect("env-before-read-docs", create_pep_zero) # PEP 0 hook
# Mathematics rendering
inline_maths = HTMLTranslator.visit_math, _depart_maths
From 0357bb30d613b43db26a013151d8a66ac4b2a552 Mon Sep 17 00:00:00 2001
From: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Date: Thu, 13 Jan 2022 17:36:01 +0000
Subject: [PATCH 08/30] Pull request rendering statement
---
pep-0676.rst | 3 +++
1 file changed, 3 insertions(+)
diff --git a/pep-0676.rst b/pep-0676.rst
index b86dbc9a42c..b955e1f920a 100644
--- a/pep-0676.rst
+++ b/pep-0676.rst
@@ -106,6 +106,9 @@ The proposed specification for rendering the PEP files to HTML is as per the
The rendered PEPs MUST be available at `peps.python.org`_. These SHOULD be
hosted as static files, and MAY be behind a content delivery network (CDN).
+A service to render previews of pull requests SHOULD be provided. This service
+MAY be integrated with the hosting and deployment solution.
+
The following redirect rules MUST be created for the `python.org`_ domain:
* ``/peps/`` -> https://peps.python.org/
From 7667c571056157fe8aff66e86fb8932a195bd195 Mon Sep 17 00:00:00 2001
From: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Date: Thu, 13 Jan 2022 23:05:27 +0000
Subject: [PATCH 09/30] Add end user docs
---
docs/build.rst | 122 +++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 122 insertions(+)
create mode 100644 docs/build.rst
diff --git a/docs/build.rst b/docs/build.rst
new file mode 100644
index 00000000000..8bd0c1f3726
--- /dev/null
+++ b/docs/build.rst
@@ -0,0 +1,122 @@
+..
+ Author: Adam Turner
+
+
+Building PEPs Locally
+=====================
+
+Whilst editing a PEP, it is useful to review the rendered output locally. This
+can also be used to check that the PEP is valid reStructuredText before
+submission to the PEP editors.
+
+The rest of this document assumes you are working from a local clone of the
+`PEPs repository