Skip to content

Fix Gateway links in code blocks #3444

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

Merged
merged 2 commits into from
Nov 17, 2025
Merged

Fix Gateway links in code blocks #3444

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
be58500
docs: fix gateway links in code blocks
NicolasPllr1 Nov 16, 2025
5b44e80
Merge branch 'main' into fix-gateway-codeblock-links
DouweM Nov 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/.hooks/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@

def on_page_markdown(markdown: str, page: Page, config: Config, files: Files) -> str:
"""Called on each file after it is read and before it is converted to HTML."""
relative_path_root = (DOCS_ROOT / page.file.src_uri).parent
markdown = inject_snippets(markdown, relative_path_root)
relative_path = DOCS_ROOT / page.file.src_uri
markdown = inject_snippets(markdown, relative_path.parent)
markdown = replace_uv_python_run(markdown)
markdown = render_examples(markdown)
markdown = render_video(markdown)
markdown = create_gateway_toggle(markdown, relative_path_root)
markdown = create_gateway_toggle(markdown, relative_path)
return markdown


Expand Down Expand Up @@ -120,13 +120,13 @@ def sub_cf_video(m: re.Match[str]) -> str:
"""


def create_gateway_toggle(markdown: str, relative_path_root: Path) -> str:
def create_gateway_toggle(markdown: str, relative_path: Path) -> str:
"""Transform Python code blocks with Agent() calls to show both Pydantic AI and Gateway versions."""
# Pattern matches Python code blocks with or without attributes, and optional annotation definitions after
# Annotation definitions are numbered list items like "1. Some text" that follow the code block
return re.sub(
r'```py(?:thon)?(?: *\{?([^}\n]*)\}?)?\n(.*?)\n```(\n\n(?:\d+\..+?\n)+?\n)?',
lambda m: transform_gateway_code_block(m, relative_path_root),
lambda m: transform_gateway_code_block(m, relative_path),
markdown,
flags=re.MULTILINE | re.DOTALL,
)
Expand All @@ -136,7 +136,7 @@ def create_gateway_toggle(markdown: str, relative_path_root: Path) -> str:
GATEWAY_MODELS = ('anthropic', 'openai', 'openai-responses', 'openai-chat', 'bedrock', 'google-vertex', 'groq')


def transform_gateway_code_block(m: re.Match[str], relative_path_root: Path) -> str:
def transform_gateway_code_block(m: re.Match[str], relative_path: Path) -> str:
"""Transform a single code block to show both versions if it contains Agent() calls."""
attrs = m.group(1) or ''
code = m.group(2)
Expand Down Expand Up @@ -186,9 +186,9 @@ def replace_agent_model(match: re.Match[str]) -> str:

# Build attributes string
docs_path = DOCS_ROOT / 'gateway'
relative_path = docs_path.relative_to(relative_path_root, walk_up=True)
link = f"<a href='{relative_path}' style='float: right;'>Learn about Gateway</a>"

relative_path_to_gateway = docs_path.relative_to(relative_path, walk_up=True)
link = f"<a href='{relative_path_to_gateway}' style='float: right;'>Learn about Gateway</a>"
attrs_str = f' {{{attrs}}}' if attrs else ''

if 'title="' in attrs:
Expand Down