Skip to content

[Docs] Fix titles for multi-file examples that are rendered in the docs #23573

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 1 commit into from
Aug 26, 2025
Merged

[Docs] Fix titles for multi-file examples that are rendered in the docs #23573

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 16 additions & 4 deletions docs/mkdocs/hooks/generate_examples.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,10 @@ def __post_init__(self):
self.other_files = self.determine_other_files()
self.title = self.determine_title()

@property
def is_code(self) -> bool:
return self.main_file.suffix != ".md"

def determine_main_file(self) -> Path:
"""
Determines the main file in the given path.
Expand Down Expand Up @@ -101,6 +105,12 @@ def determine_other_files(self) -> list[Path]:
return [file for file in self.path.rglob("*") if is_other_file(file)]

def determine_title(self) -> str:
if not self.is_code:
with open(self.main_file) as f:
first_line = f.readline().strip()
match = re.match(r'^#\s+(?P<title>.+)$', first_line)
if match:
return match.group('title')
return fix_case(self.path.stem.replace("_", " ").title())

def generate(self) -> str:
Expand All @@ -110,11 +120,13 @@ def generate(self) -> str:
# Use long code fence to avoid issues with
# included files containing code fences too
code_fence = "``````"
is_code = self.main_file.suffix != ".md"
if is_code:
# Skip the title from md snippets as it's been included above
start_line = 2
if self.is_code:
content += f"{code_fence}{self.main_file.suffix[1:]}\n"
content += f'--8<-- "{self.main_file}"\n'
if is_code:
start_line = 1
content += f'--8<-- "{self.main_file}:{start_line}"\n'
if self.is_code:
content += f"{code_fence}\n"
content += "\n"

Expand Down