Fix Gateway links in code blocks #3444
Open
+8
−8
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem (docs)
I found broken 'Learn about Gateway' links in code blocks (e.g. here) reading the docs, which led me to try and fix them!
I think the problem is in the
transform_gateway_code_blockfunction. It tries to compute a relative path to the Gateway page using the parent of the current page (relative_path_root) instead of the page itself:pydantic-ai/docs/.hooks/main.py
Lines 188 to 190 in 359c6d2
This is the logic I tried to fix. I tested a few links locally and they seem to be working now ; )
Hope this is enough and helps!
Couple of tests:
Related Issue