8000 Sphinx - PEP 0 generation by AA-Turner · Pull Request #1932 · python/peps · GitHub
[go: up one dir, main page]
Skip to content

Sphinx - PEP 0 generation #1932

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

Jump to bottom
Merged
merged 37 commits into from
Jun 12, 2021
Merged

Sphinx - PEP 0 generation #1932

merged 37 commits into from
Jun 12, 2021

Conversation

AA-Turner
Copy link
Member

See #2, #1385 for context. Superseeds #1567.

This is the PEP 0 generation part, building on PR #1930. It contains the logic for parsing all PEPs and building the PEP index:

  • PEP 0 parser - Parses PEP and Author data
  • PEP 0 writer - Writes actual PEP-0000.rst file
  • PEP 0 generator Orchestrates process, entry point & docutils integration
  • AUTHORS.csv - explicit author overrides

Note that this PR also contains elements from PR #1386.

@AA-Turner AA-Turner requested a review from a team as a code owner April 20, 2021 22:34
@AA-Turner AA-Turner mentioned this pull request May 5, 2021
Closed
8000
@AA-Turner AA-Turner force-pushed the sphinx-pep-zero branch 3 times, most recently from 5faec5d to 1439cad Compare May 7, 2021 15:05
@pablogsal
Copy link
Member

This also needs rebasing

@AA-Turner
Copy link
Member Author

Rebased

@AA-Turner AA-Turner mentioned this pull request Jun 9, 2021
Merged
@pablogsal
Copy link
Member

Moar rebasing 😉

@AA-Turner
Copy link
Member Author

yup, one sec

@AA-Turner
Copy link
Member Author

rebased take 2

@pablogsal
Copy link
Member

Can you give me some context on why we need the authors override file? I have a guess but I would like to know the extent of the problem and why is needed now and not before.

pablogsal
pablogsal reviewed Jun 9, 2021
View reviewed changes
pablogsal
pablogsal reviewed Jun 9, 2021
View reviewed changes
@AA-Turner
Copy link
Member Author
AA-Turner commented Jun 9, 2021 •
edited
Loading

Can you give me some context on why we need the authors override file? I have a guess but I would like to know the extent of the problem and why is needed now and not before.

as authors names were parsed wrong / duplicates missed (currently on /dev/python/)

prev discussion:
#2 (comment)
#1386 (comment)
#1386 (comment)

why not before - no idea, but I like to leave things better than I found them

pablogsal
pablogsal reviewed Jun 9, 2021
View reviewed changes
pablogsal
pablogsal reviewed Jun 9, 2021
View reviewed changes
pablogsal
pablogsal reviewed Jun 9, 2021
View reviewed changes
pablogsal
pablogsal reviewed Jun 9, 2021
View reviewed changes
@pablogsal
Copy link
Member

prev discussion:

I assume https://github.com/python/peps/pull/1386/files is included here no?

@AA-Turner
Copy link
Member Author

prev discussion:

I assume #1386 (files) is included here no?

yes

@pablogsal
Copy link
Member

Will make another pass tomorrow :)

@AA-Turner
Copy link
Member Author

@pablogsal done, and fixed that I accidentally left out the hook into the Sphinx build process!

Apart from that some refactoring for ease of reading / future maintenence - the PEP 0 generation was the area I hadn't touched much as slightly scared to break it!

pablogsal
pablogsal reviewed Jun 10, 2021
View reviewed changes
@pablogsal
Copy link
Member

Left one comment, otherwise looks good to me

pablogsal
pablogsal reviewed Jun 10, 2021
View reviewed changes
@pablogsal pablogsal merged commit 749c2d9 into python:master Jun 12, 2021
@AA-Turner AA-Turner deleted the sphinx-pep-zero branch July 4, 2021 18:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pablogsal pablogsal pablogsal approved these changes

Assignees
No one assigned
Labels
CLA signed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@AA-Turner @pablogsal @the-knights-who-say-ni
0