Skip to content

Commit f126543

Browse files
Documentation: replace module page titles with Overview
1 parent 362337e commit f126543

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

Doc/md_filter.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,14 @@ def clean_header_title(text):
9999
# Remove extra whitespace.
100100
return text.strip()
101101

102+
TITLE_REPLACEMENTS = {
103+
"Diligent Engine": "Overview",
104+
"Diligent Core": "Overview",
105+
"Diligent Tools": "Overview",
106+
"Diligent FX": "Overview",
107+
"Diligent Samples": "Overview"
108+
}
109+
102110
def process_content(input_filepath, lines):
103111
root_dir = get_project_root()
104112

@@ -122,6 +130,8 @@ def process_content(input_filepath, lines):
122130
match = header_regex.match(line)
123131
if match:
124132
header_title = clean_header_title(match.group(2))
133+
if header_title in TITLE_REPLACEMENTS:
134+
header_title = TITLE_REPLACEMENTS[header_title]
125135
# Replace the header with the \page command.
126136
output_lines.append(f"\\page {page_id} {header_title}\n")
127137
header_replaced = True

0 commit comments

Comments
 (0)