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

Allow title and fragments in PEP and RFC references #2251

Merged

Conversation

AA-Turner
Copy link
Member

@AA-Turner AA-Turner commented Jan 19, 2022

This patches Docutils in pep2html to allow the syntax of :pep:`title <3000#section>`. Users of Sphinx will be familiar with this, and e.g. in #2248 there is no clean way to express the author's intent without this.

Passing test run at https://github.com/AA-Turner/peps/runs/4872058326 -- from this commit AA-Turner@5449914

cc @JelleZijlstra (you've merged a few of my recent ones so sorry for taking advantage of your good nature!)

A

@JelleZijlstra
Copy link
Member

Would it be feasible to start writing unit tests for this script?

@Rosuav
Copy link
Contributor

Rosuav commented Jan 19, 2022

Ooh that looks useful. I like it.

@AA-Turner
Copy link
Member Author

Would it be feasible to start writing unit tests for this script?

For pep2html? I wonder if it would be worth the time investment given PEP 676? (Of course, 676 could be rejected!)

The inspiration for the code here was taken from Sphinx, although I used a function based method -- as Sphinx does a lot more they implement a few base classes etc.

I want to upstream this logic into Docutils, but that project doesn't move amazingly quickly.

A

@JelleZijlstra
Copy link
Member

Ah, I didn't realize PEP 676 would replace this. Let's just merge as is then.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants