')
lines.append("")
permalink = f'
#' if anchor else ""
lines.append(f"**`{fname}`** {badge_str}{permalink}")
@@ -3020,7 +3010,7 @@ def generate_emulator_page(
if profile.get("type") == "alias":
parent = profile.get("alias_of", profile.get("bios_identical_to", "unknown"))
return (
- f"# {name} - {SITE_NAME}\n\n"
+ f"# {name}\n\n"
f"This core uses the same firmware as **{parent}**.\n\n"
f"See [{parent}]({parent}.md) for details.\n"
)
@@ -3057,7 +3047,7 @@ def generate_emulator_page(
data_dirs = profile.get("data_directories", [])
lines = [
- f"# {emu_name} - {SITE_NAME}",
+ f"# {emu_name}",
"",
'
',
"",
@@ -3378,7 +3368,7 @@ def generate_gap_analysis(
)
lines = [
- f"# Gap Analysis - {SITE_NAME}",
+ "# Gap Analysis",
"",
"Unified view of BIOS verification, file provenance, and coverage gaps.",
"",
@@ -3944,7 +3934,7 @@ def generate_cross_reference(
})
lines = [
- f"# Cross-reference - {SITE_NAME}",
+ "# Cross-reference",
"",
f"Platform > Core > Systems > Upstream emulator. "
f"{total_cores} cores across {len(coverages)} platforms, "
@@ -3968,7 +3958,7 @@ def generate_cross_reference(
def generate_contributing() -> str:
return contributing_text(
- lambda page: f"{page}.md", "# Contributing - RetroBIOS", "on this site"
+ lambda page: f"{page}.md", "# Contributing", "on this site"
)
@@ -3987,7 +3977,7 @@ def generate_wiki_data_model(db: dict, profiles: dict) -> str:
by_sha256 = len(db.get("indexes", {}).get("by_sha256", {}))
lines = [
- f"# Data model - {SITE_NAME}",
+ "# Data model",
"",
"## database.json",
"",
diff --git a/tests/test_site_validation.py b/tests/test_site_validation.py
index 6e9b079d..f9c9820f 100644
--- a/tests/test_site_validation.py
+++ b/tests/test_site_validation.py
@@ -3,6 +3,7 @@
from __future__ import annotations
import json
+import re
import sys
import tempfile
import unittest
@@ -254,5 +255,40 @@ class PlatformPagesPrintTheDeclaredCrc32(unittest.TestCase):
self.assertIn("CRC32: `91e93107`", page.read_text(encoding="utf-8"))
+class PlainHouseStyle(unittest.TestCase):
+ """The stylesheet stays a plain documentation theme.
+
+ Gradient banners, coloured side stripes on cards, lifting hover cards,
+ pill badges and small-caps table headers had piled up into the look of
+ a generated landing page. Each pattern below brought one of them back.
+ """
+
+ PATTERNS = {
+ "gradient": re.compile(r"gradient\("),
+ "side stripe": re.compile(r"border-(?:left|inline-start)\s*:\s*\d+px"),
+ "lifting card": re.compile(r"translateY\("),
+ "drop shadow": re.compile(r"box-shadow"),
+ "small caps header": re.compile(r"text-transform\s*:\s*uppercase"),
+ "pill": re.compile(r"border-radius\s*:\s*(?:[5-9]|\d{2,})px|50%"),
+ "box-drawing rule": re.compile("[\u2500-\u257f]"),
+ }
+
+ def test_the_stylesheet_has_none_of_the_patterns(self):
+ css = (ROOT / "docs_assets" / "extra.css").read_text(encoding="utf-8")
+ for label, pattern in self.PATTERNS.items():
+ with self.subTest(pattern=label):
+ self.assertIsNone(pattern.search(css), label)
+
+ def test_headings_do_not_repeat_the_site_name(self):
+ # The header bar already names the site, and the browser title gets
+ # it from the theme: "# DuckStation - RetroBIOS" said it twice.
+ source = (ROOT / "scripts" / "generate_site.py").read_text(encoding="utf-8")
+ self.assertNotRegex(source, r'"# [^"]* - (?:\{SITE_NAME\}|RetroBIOS)')
+ for page in sorted((ROOT / "wiki").glob("*.md")):
+ first = page.read_text(encoding="utf-8").splitlines()[0]
+ with self.subTest(page=page.name):
+ self.assertFalse(first.endswith(" - RetroBIOS"), first)
+
+
if __name__ == "__main__":
unittest.main()
diff --git a/wiki/architecture.md b/wiki/architecture.md
index 1e7b3dc1..f882f5cb 100644
--- a/wiki/architecture.md
+++ b/wiki/architecture.md
@@ -1,4 +1,4 @@
-# Architecture - RetroBIOS
+# Architecture
## Directory structure
diff --git a/wiki/faq.md b/wiki/faq.md
index a0308877..00b41cb8 100644
--- a/wiki/faq.md
+++ b/wiki/faq.md
@@ -1,4 +1,4 @@
-# FAQ - RetroBIOS
+# FAQ
## My game shows a black screen
diff --git a/wiki/getting-started.md b/wiki/getting-started.md
index 3206430c..bfd6d53f 100644
--- a/wiki/getting-started.md
+++ b/wiki/getting-started.md
@@ -1,4 +1,4 @@
-# Getting started - RetroBIOS
+# Getting started
## What are BIOS files?
diff --git a/wiki/index.md b/wiki/index.md
index fe239ad1..919556c1 100644
--- a/wiki/index.md
+++ b/wiki/index.md
@@ -1,4 +1,4 @@
-# Wiki - RetroBIOS
+# Wiki
Technical documentation for the RetroBIOS toolchain.
diff --git a/wiki/installer.md b/wiki/installer.md
index faa6298b..4fe7eb0d 100644
--- a/wiki/installer.md
+++ b/wiki/installer.md
@@ -1,4 +1,4 @@
-# Installer - RetroBIOS
+# Installer
Reference for `install.sh`, `install.ps1` and `install.py`: what the one-liner
runs, what it detects, where the bytes come from and what it is allowed to
diff --git a/wiki/profiling.md b/wiki/profiling.md
index 9490de14..c75d8473 100644
--- a/wiki/profiling.md
+++ b/wiki/profiling.md
@@ -1,4 +1,4 @@
-# Profiling guide - RetroBIOS
+# Profiling guide
How to create an emulator profile from source code.
diff --git a/wiki/tools.md b/wiki/tools.md
index a9aacedd..b7c87a18 100644
--- a/wiki/tools.md
+++ b/wiki/tools.md
@@ -1,4 +1,4 @@
-# Tools - RetroBIOS
+# Tools
All tools are Python scripts in `scripts/`. They need Python 3.12 and `pyyaml`;
only `validate_schemas.py` also needs `jsonschema[format-nongpl]`. `install.py`
diff --git a/wiki/troubleshooting.md b/wiki/troubleshooting.md
index a263c8d6..b6ada15a 100644
--- a/wiki/troubleshooting.md
+++ b/wiki/troubleshooting.md
@@ -1,4 +1,4 @@
-# Troubleshooting - RetroBIOS
+# Troubleshooting
Diagnosis guide organized by symptom. Each section describes what to check and how to fix it.