@@ -14,17 +14,17 @@ Abstract
14
14
========
15
15
16
16
This PEP addresses the infrastructure around rendering PEP files from
17
- `reStructuredText `_ files to HTML web pages . We aim to specify a self-contained
17
+ `reStructuredText `_ files to HTML webpages . We aim to specify a self-contained
18
18
and maintainable solution for PEP readers, authors, and editors.
19
19
20
20
21
21
Motivation
22
22
==========
23
23
24
24
As of November 2021, Python Enhancement Proposals (PEPs) are rendered in a
25
- multi-system, multi-stage process. A Continuous Integration (CI) task runs a
25
+ multi-system, multi-stage process. A continuous integration (CI) task runs a
26
26
`docutils `_ script to render all PEP files individually. The CI task then
27
- uploads a TAR to a server, where it is retrieved and rendered into the
27
+ uploads a tar archive to a server, where it is retrieved and rendered into the
28
28
`python.org `_ website periodically.
29
29
30
30
This places a constraint on the `python.org `_ website to handle raw HTML
39
39
* solve a number of outstanding issues, and lay the path for improvements
40
40
* save volunteer maintainers' time
41
41
42
- We propose that PEPs are accessed through `` peps.python.org `` at the top-level
43
- namespace (for example, `` peps.python.org/pep-0008/ `` ), and that all custom
42
+ We propose that PEPs are accessed through `peps.python.org `_ as the top-level
43
+ namespace (for example, `peps.python.org/pep-0008 `_ ), and that all custom
44
44
tooling to support rendering PEPs is hosted in the `python/peps `_ repository.
45
45
46
46
@@ -101,11 +101,11 @@ Specification
101
101
The proposed specification for rendering the PEP files to HTML is as per the
102
102
`reference implementation `_.
103
103
104
- The HTML files SHOULD be made available under the `` peps.python.org `` domain.
104
+ The HTML files SHOULD be made available under the `peps.python.org `_ domain.
105
105
The rendered output SHOULD be hosted as static files, and MAY be behind a
106
106
content delivery network (CDN).
107
107
108
- The following redirect rules MUST be created from the `python.org `_ domain:
108
+ The following redirect rules MUST be created for the `python.org `_ domain:
109
109
110
110
* ``/peps/ `` -> https://peps.python.org/
111
111
* ``/dev/peps/ `` -> https://peps.python.org/
@@ -148,7 +148,7 @@ Security Implications
148
148
The main `python.org `_ website will no longer need to process raw HTML
149
149
uploads, closing a potential threat vector, and the PEP building and
150
150
deployment process will use modern, well maintained code and secure
151
- automated platforms, reducing likely potential attack surface. Therefore,
151
+ automated platforms, reducing the likely potential attack surface. Therefore,
152
152
there is no forseen negative security impact.
153
153
154
154
@@ -204,6 +204,8 @@ Footnotes
204
204
.. _docutils : https://docutils.sourceforge.io
205
205
.. _Makefile : https://www.gnu.org/software/make/manual/make.html#Introduction
206
206
.. _python.org : https://www.python.org
207
+ .. _peps.python.org : https://peps.python.org/
208
+ .. _peps.python.org/pep-0008 : https://peps.python.org/pep-0008/
207
209
.. _python/peps : https://github.com/python/peps
208
210
.. _Read the Docs : https://readthedocs.org
209
211
.. _reStructuredText : https://docutils.sourceforge.io/rst.html
0 commit comments