mirror of
https://github.com/Abdess/retroarch_system.git
synced 2026-04-14 12:52:31 -05:00
docs: add wiki pages for all audiences, fix .old.yml leak
9 new wiki pages: getting-started, faq, troubleshooting, advanced-usage, verification-modes, adding-a-platform, adding-a-scraper, testing-guide, release-process. Updated architecture.md with mermaid diagrams, tools.md with full pipeline and target/exporter sections, profiling.md with missing fields, index.md with glossary and nav links. Expanded CONTRIBUTING.md from stub to full contributor guide. Filter .old.yml from load_emulator_profiles, generate_db alias collection, and generate_readme counts. Fix BizHawk sha1 mode in tools.md, fix RetroPie path, fix export_truth.py typos.
This commit is contained in:
@@ -683,6 +683,8 @@ def load_emulator_profiles(
|
||||
if not emu_path.exists():
|
||||
return profiles
|
||||
for f in sorted(emu_path.glob("*.yml")):
|
||||
if f.name.endswith(".old.yml"):
|
||||
continue
|
||||
with open(f) as fh:
|
||||
profile = yaml.safe_load(fh) or {}
|
||||
if "emulator" not in profile:
|
||||
|
||||
@@ -401,6 +401,8 @@ def _collect_all_aliases(files: dict) -> dict:
|
||||
try:
|
||||
import yaml
|
||||
for emu_file in emulators_dir.glob("*.yml"):
|
||||
if emu_file.name.endswith(".old.yml"):
|
||||
continue
|
||||
try:
|
||||
with open(emu_file) as f:
|
||||
emu_config = yaml.safe_load(f) or {}
|
||||
|
||||
@@ -91,6 +91,7 @@ def generate_readme(db: dict, platforms_dir: str) -> str:
|
||||
|
||||
emulator_count = sum(
|
||||
1 for f in Path("emulators").glob("*.yml")
|
||||
if not f.name.endswith(".old.yml")
|
||||
) if Path("emulators").exists() else 0
|
||||
|
||||
# Count systems from emulator profiles
|
||||
@@ -100,6 +101,8 @@ def generate_readme(db: dict, platforms_dir: str) -> str:
|
||||
try:
|
||||
import yaml
|
||||
for f in emu_dir.glob("*.yml"):
|
||||
if f.name.endswith(".old.yml"):
|
||||
continue
|
||||
with open(f) as fh:
|
||||
p = yaml.safe_load(fh) or {}
|
||||
system_ids.update(p.get("systems", []))
|
||||
|
||||
@@ -1358,6 +1358,8 @@ The CI automatically:
|
||||
|
||||
|
||||
# Wiki pages
|
||||
# index, architecture, tools, profiling are maintained as wiki/ sources
|
||||
# and copied verbatim by main(). Only data-model is generated dynamically.
|
||||
|
||||
def generate_wiki_index() -> str:
|
||||
"""Generate wiki landing page."""
|
||||
@@ -1994,10 +1996,19 @@ def generate_mkdocs_nav(
|
||||
|
||||
wiki_nav = [
|
||||
{"Overview": "wiki/index.md"},
|
||||
{"Getting started": "wiki/getting-started.md"},
|
||||
{"FAQ": "wiki/faq.md"},
|
||||
{"Troubleshooting": "wiki/troubleshooting.md"},
|
||||
{"Architecture": "wiki/architecture.md"},
|
||||
{"Tools": "wiki/tools.md"},
|
||||
{"Profiling guide": "wiki/profiling.md"},
|
||||
{"Advanced usage": "wiki/advanced-usage.md"},
|
||||
{"Verification modes": "wiki/verification-modes.md"},
|
||||
{"Data model": "wiki/data-model.md"},
|
||||
{"Profiling guide": "wiki/profiling.md"},
|
||||
{"Adding a platform": "wiki/adding-a-platform.md"},
|
||||
{"Adding a scraper": "wiki/adding-a-scraper.md"},
|
||||
{"Testing guide": "wiki/testing-guide.md"},
|
||||
{"Release process": "wiki/release-process.md"},
|
||||
]
|
||||
|
||||
return [
|
||||
@@ -2180,7 +2191,7 @@ plugins:
|
||||
+ 1 # cross-reference
|
||||
+ 1 + len(profiles) # emulator index + detail
|
||||
+ 1 # gap analysis
|
||||
+ 5 # wiki (index, architecture, tools, profiling, data model)
|
||||
+ 14 # wiki pages (copied from wiki/ + generated data-model)
|
||||
+ 1 # contributing
|
||||
)
|
||||
print(f"\nGenerated {total_pages} pages in {args.docs_dir}/")
|
||||
|
||||
Reference in New Issue
Block a user