Fix refs section removal breaking external links on Sphinx build too by CAM-Gerlach · Pull Request #2229 · python/peps · GitHub
Skip to content

Fix refs section removal breaking external links on Sphinx build too - #2229

Merged
JelleZijlstra merged 1 commit into
python:mainfrom
CAM-Gerlach:fix-refs-sphinx-build
Jan 12, 2022
Merged

JelleZijlstra merged 1 commit into
python:mainfrom
CAM-Gerlach:fix-refs-sphinx-build

Conversation

@CAM-Gerlach

Copy link
Copy Markdown
Member

Followup to #2227 to fix #2155 for the new Sphinx build; I'd previously attempted to reproduce the issue locally on the same PEP and it apparently didn't occur, but I didn't realize I was looking at a stale built file, and it turns out that in fact the same fix is needed. Sorry for the double PR!

@CAM-Gerlach

Copy link
Copy Markdown
Member Author

@JelleZijlstra
JelleZijlstra merged commit 57c9a36 into python:main Jan 12, 2022
@JelleZijlstra

Copy link
Copy Markdown
Member

It worked :)

@JelleZijlstra

Copy link
Copy Markdown
Member

But the deploy job failed: https://github.com/python/peps/actions/runs/1685665720. Let's just give GH some time to fix things and maybe rerun it later.

@CAM-Gerlach

Copy link
Copy Markdown
Member Author

Looks like it has been resolved. Could you re-run?

@pradyunsg

Copy link
Copy Markdown
Member

And, the re-run seems to have succeeded!

@AA-Turner

Copy link
Copy Markdown
Member

Thanks for catching this Cam/all -- docutils can be annoyingly fickle sometimes.

As a post-mortem, what we should have done initially is made all target children of the references section children of the document.

Deferring the transform is probably the smallest change to fix it though, and we don't rely on any behaviour transforming the footer links, so all good. Thanks again!

A

@CAM-Gerlach
CAM-Gerlach deleted the fix-refs-sphinx-build branch January 12, 2022 18:54
@CAM-Gerlach

Copy link
Copy Markdown
Member Author

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.

5 participants