Skip to content
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.

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

Convert text-based PEPs to reST #4

Closed
brettcannon opened this issue Jun 15, 2016 · 16 comments
Closed

Convert text-based PEPs to reST #4

brettcannon opened this issue Jun 15, 2016 · 16 comments

Comments

@brettcannon
Copy link
Member

Not really important, but it does unify things.

@Carreau
Copy link
Contributor

Carreau commented Jun 21, 2016

Stupid existential question, should pep-9 (Sample Plaintext PEP Template) be converted to rst ?

@Rosuav
Copy link
Contributor

Rosuav commented Jun 21, 2016

Haha, good question. Maybe keep it as text and identify it as deprecated?

@Carreau
Copy link
Contributor

Carreau commented Jun 21, 2016

Haha, good question. Maybe keep it as text and identify it as deprecated?

It is already. But if not converted, that would make it trickier to automatize the Sphinx build process.

One possibility is to put the all content of the pep in code block. Indented by 4 spaces, and add an warning on top.

@brettcannon
Copy link
Member Author

That's a possibility. I would leave that PEP for last for conversion as it's obviously the least important one to convert.

@brettcannon
Copy link
Member Author

#142, #143, #144, and #148 are conversions from text to reST.

@Mariatta
Copy link
Member

Mariatta commented Dec 4, 2016

Not including PEP 9, there are 133 more PEPs still in plain text :P

@gvanrossum
Copy link
Member

gvanrossum commented Dec 4, 2016 via email

@brettcannon
Copy link
Member Author

Once you're comfortable that your script isn't going to break anything, @Mariatta , then I would be fine with one big PR or batches of PRs that converts several of the text-only PEPs at once. We have version control for a reason. 😄

@Carreau
Copy link
Contributor

Carreau commented Dec 25, 2016

For the few peps I made into rst I used this, if it can be of help. I found that a couple of peps/peps author were using different style and the you regularly need to make manual check/fixes after auto transform.

Mariatta added a commit to Mariatta/peps that referenced this issue Jan 7, 2017
PEP 160
PEP 210
PEP 217
PEP 220
PEP 233
PEP 251
PEP 254
PEP 260
PEP 270
PEP 271

Continuing work on python#4 :)
brettcannon pushed a commit that referenced this issue Jan 7, 2017
Continuing work on #4
ncoghlan pushed a commit that referenced this issue Feb 6, 2017
Further progress on issue #4 

PEP 213:
- Fix typo in the word miniscule -> minuscule

PEP 241

PEP 291

PEP 298

PEP 311
This was referenced May 26, 2017
@brettcannon
Copy link
Member Author

brettcannon commented Jun 2, 2017

I just ran grep -i -L "^Content-Type: text/x-rst" *.txt over repo and this is what I got:

pep-0000.txt
pep-0009.txt
pep-0100.txt
pep-0101.txt
pep-0102.txt
pep-0205.txt
pep-0207.txt
pep-0209.txt
pep-0214.txt
pep-0225.txt
pep-0227.txt
pep-0230.txt
pep-0231.txt
pep-0234.txt
pep-0242.txt
pep-0245.txt
pep-0246.txt
pep-0252.txt
pep-0253.txt
pep-0255.txt
pep-0262.txt
pep-0275.txt
pep-0276.txt
pep-0280.txt
pep-0282.txt
pep-0285.txt
pep-0293.txt
pep-0296.txt
pep-0308.txt
pep-0319.txt
pep-0323.txt
pep-0324.txt
pep-0340.txt
pep-0343.txt
pep-0354.txt
pep-0355.txt
pep-0363.txt
pep-0371.txt
pep-0397.txt
pep-0450.txt
pep-0452.txt
pep-3101.txt
pep-3143.txt
pep-3148.txt

That's 44 PEPs left to convert (although PEP 0 is auto-generated so that's a bit different than the rest).

@mozillazg
Copy link
Contributor

All done! 🎇🎉

$ grep -i -L "^Content-Type: \+text/x-rst" *.txt
pep-0009.txt

@gvanrossum
Copy link
Member

Whee! Now we can rename all .txt files to .rst, and remove a bunch of stuff from pep2html.py. Right?

@Mariatta
Copy link
Member

Amazing! Thanks @mozillazg ! 🌮

@brettcannon
Copy link
Member Author

@gvanrossum #1 tracks renaming the PEPs. As for cleaning up pep2html, we could either do that or try and build the PEPs using sphinx ( #2 ).

brettcannon added a commit to brettcannon/peps that referenced this issue Oct 25, 2017
brettcannon added a commit that referenced this issue Oct 25, 2017
@brettcannon
Copy link
Member Author

And with PEP 9 now converted, this is done! Thanks to everyone who helped make this happen! And now on to #1 😃

willingc pushed a commit to willingc/peps that referenced this issue Sep 11, 2019
Add review comments and edits
lukpueh pushed a commit to lukpueh/peps that referenced this issue Oct 10, 2019
…online-keys

Discuss how to manage online and offline keys
hauntsaninja added a commit to hauntsaninja/peps that referenced this issue Sep 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants