Skip to content

PEP 1 and 12: Document Topic header #2995

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
hugovk merged 7 commits into from
Feb 3, 2023
Merged

PEP 1 and 12: Document Topic header #2995

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d2ad2df
Add topic header to PEPs 1 and 12
hugovk Jan 31, 2023
d33389e
Review updates
hugovk Feb 1, 2023
930c77e
Redirect topics to topic/
hugovk Feb 1, 2023
481761e
Update topics->topic redirect
hugovk Feb 2, 2023
c5a5811
Singular topic
hugovk Feb 2, 2023
d75d4cd
Add topic header to PEP 12
hugovk Feb 2, 2023
16f6d7a
Add htmlview target to Makefile
hugovk Feb 2, 2023
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
10 changes: 10 additions & 0 deletions infra/main.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,16 @@ resource "fastly_service_vcl" "peps" {
EOT
}

snippet {
name = "topics"
type = "recv"
content = <<-EOT
if (req.url == "/topics") {
set req.url = "/topic/";
}
EOT
}

snippet {
name = "redirect"
type = "error"
Expand Down
5 changes: 5 additions & 0 deletions pep-0001.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -605,6 +605,7 @@ optional and are described below. All other headers are required.
Status: <Draft | Active | Accepted | Provisional | Deferred | Rejected |
Withdrawn | Final | Superseded>
Type: <Standards Track | Informational | Process>
* Topic: <Governance | Packaging | Release | Typing>
* Content-Type: text/x-rst
* Requires: <pep numbers>
Created: <date created on, in dd-mmm-yyyy format>
Expand Down Expand Up @@ -659,6 +660,10 @@ archives, rather than just a mailto: or hyperlink to the list itself.
The Type header specifies the type of PEP: Standards Track,
Informational, or Process.

The optional Topic header lists which special topics, if any,
the PEP belongs under.
See the :ref:`topic-index` for the existing topics.

The format of a PEP is specified with a Content-Type header.
All PEPs must use reStructuredText (see :pep:`12`),
and have a value of ``text/x-rst``, the default.
Expand Down
1 change: 1 addition & 0 deletions pep-0012/pep-NNNN.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ PEP-Delegate: <PEP delegate's real name>
Discussions-To: <REQUIRED: URL of current canonical discussion thread>
Status: <REQUIRED: Draft | Active | Accepted | Provisional | Deferred | Rejected | Withdrawn | Final | Superseded>
Type: <REQUIRED: Standards Track | Informational | Process>
Topic: <Governance | Packaging | Release | Typing>
Content-Type: text/x-rst
Requires: <pep numbers>
Created: <date created on, in dd-mmm-yyyy format>
Expand Down
2 changes: 2 additions & 0 deletions pep_sphinx_extensions/pep_zero_generator/subindices.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ def generate_subindices(

def generate_topic_contents(docnames: list[str], env: BuildEnvironment):
update_sphinx("topic/index", """\
.. _topic-index:

Topic Index
***********

Expand Down