Merge pull request #1095 from UE4SS-RE/pushdocsupdates

Update mdBook and cargo-binstall versions

Author: narknon

.github/workflows/pushdocs.yml

@@ -21,12 +21,12 @@ jobs:
           python-version: '3.x'
 
       - name: Setup mdBook Preprocessors
-        uses: cargo-bins/cargo-binstall@v1.6.8
+        uses: cargo-bins/cargo-binstall@v1.16.2
 
       - name: Setup mdBook
         run: |
           mkdir mdbook
-          curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.14/mdbook-v0.4.14-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
+          curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.5.1/mdbook-v0.5.1-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
           echo `pwd`/mdbook >> $GITHUB_PATH
 
       - name: Install mdBook Preprocessors

docs-export/book.toml

@@ -1,6 +1,5 @@
 [book]
 language = "en"
-multilingual = false
 src = "src"
 title = "UE4SS Documentation"
 
@@ -9,6 +8,4 @@ additional-css = ["css/custom.css"]
 
 [output.html.fold]
 enable = true
-level = 1
-
-[preprocessor.alerts]
+level = 1

docs-export/deduplicate_summary.py

@@ -0,0 +1,62 @@
+#!/usr/bin/env python3
+
+import os
+import sys
+import re
+
+def deduplicate_summary(summary_path):
+    """
+    Remove duplicate file references from SUMMARY.md while preserving structure.
+    Keeps the first occurrence of each unique file path.
+    """
+    if not os.path.exists(summary_path):
+        return False
+
+    with open(summary_path, 'r', encoding='utf-8') as f:
+        lines = f.readlines()
+
+    seen_paths = set()
+    new_lines = []
+    modified = False
+
+    # Regex to match markdown links: [text](path)
+    link_pattern = re.compile(r'\[([^\]]+)\]\(([^)]+)\)')
+
+    for line in lines:
+        # Find all markdown links in the line
+        matches = link_pattern.findall(line)
+
+        if matches:
+            # Get the file path (remove anchors)
+            for text, path in matches:
+                # Remove anchor if present
+                clean_path = path.split('#')[0]
+
+                if clean_path in seen_paths:
+                    # This is a duplicate, comment it out
+                    if not line.strip().startswith('<!--'):
+                        line = ''
+                        modified = True
+                else:
+                    seen_paths.add(clean_path)
+
+        new_lines.append(line)
+
+    if modified:
+        with open(summary_path, 'w', encoding='utf-8') as f:
+            f.writelines(new_lines)
+        return True
+
+    return False
+
+if __name__ == '__main__':
+    if len(sys.argv) > 1:
+        summary_path = sys.argv[1]
+    else:
+        summary_path = 'SUMMARY.md'
+
+    changed = deduplicate_summary(summary_path)
+    if changed:
+        print(f"Deduplicated {summary_path}")
+    else:
+        print(f"No duplicates found in {summary_path}")

docs-export/export.py

@@ -27,6 +27,39 @@ def copy_transform(src, dst, transformer):
     with open(dst, 'w') as file:
         file.write(content)
 
+def deduplicate_summary(summary_path):
+    """Remove duplicate file references from SUMMARY.md"""
+    if not os.path.exists(summary_path):
+        return
+
+    with open(summary_path, 'r', encoding='utf-8') as f:
+        lines = f.readlines()
+
+    seen_paths = set()
+    new_lines = []
+    link_pattern = re.compile(r'\[([^\]]+)\]\(([^)]+)\)')
+
+    for line in lines:
+        matches = link_pattern.findall(line)
+        is_duplicate = False
+
+        if matches:
+            for text, path in matches:
+                clean_path = path.split('#')[0]
+                if clean_path in seen_paths:
+                    # Skip this line entirely instead of commenting it out
+                    is_duplicate = True
+                    break
+                else:
+                    seen_paths.add(clean_path)
+
+        # Only add the line if it's not a duplicate
+        if not is_duplicate:
+            new_lines.append(line)
+
+    with open(summary_path, 'w', encoding='utf-8') as f:
+        f.writelines(new_lines)
+
 def export_version(ref, name):
     docs_spec = f'{ref}:docs'
 
@@ -46,6 +79,12 @@ def export_version(ref, name):
     subprocess.check_output(('tar', 'xvf', '-', '-C', src_dir), stdin=ps.stdout)
     ps.wait()
 
+    # Deduplicate SUMMARY.md for old versions with duplicate paths
+    # mdBook v0.5+ enforces unique paths, but old release tags may have duplicates
+    # This preprocessing step removes duplicate entries before mdBook sees them
+    summary_path = os.path.join(src_dir, 'SUMMARY.md')
+    deduplicate_summary(summary_path)
+
     # copy README.md to <version>/src/
     # rewrite absolute URLs to relative mdBook URLs
     copy_transform('README.md', os.path.join(src_dir, 'README.md'), lambda content: re.sub(r'\(https://docs.ue4ss.com/dev/([^)#]+)\.html(#[^)]*)?\)', r'(\1.md\2)', content))

docs-repo-template/build.py

@@ -9,8 +9,14 @@
 build_dir = 'docs'
 
 # build release as the root
-subprocess.run(['mdbook', 'build', os.path.join('versions', 'release'), '-d', os.path.abspath(build_dir)])
+result = subprocess.run(['mdbook', 'build', os.path.join('versions', 'release'), '-d', os.path.abspath(build_dir)])
+if result.returncode != 0:
+    print(f"ERROR: Failed to build release docs")
+    exit(1)
 
 for version in os.listdir('versions'):
     version_build_dir = os.path.join(build_dir, version)
-    subprocess.run(['mdbook', 'build', os.path.join('versions', version), '-d', os.path.abspath(version_build_dir)])
+    result = subprocess.run(['mdbook', 'build', os.path.join('versions', version), '-d', os.path.abspath(version_build_dir)])
+    if result.returncode != 0:
+        print(f"WARNING: Failed to build docs for version {version}, skipping...")
+        continue

docs/SUMMARY.md

@@ -117,19 +117,15 @@
   - [Creating a C++ Mod](./guides/creating-a-c++-mod.md)
   - [Installing a C++ Mod](./guides/installing-a-c++-mod.md)
   - [GUI tabs with a C++ Mod](./guides/creating-gui-tabs-with-c++-mod.md)
+  - [Accessing UE properties with a C++ mod](./guides/accessing-ue-properties-c++.md)
 
 ## Guides
 
 - [Guides]()
   - [Fixing missing AOBs](./guides/fixing-compatibility-problems.md)
   - [Fixing missing AOBs (Advanced)](./guides/fixing-compatibility-problems-advanced.md)
   - [Generating UHT headers](./guides/generating-uht-compatible-headers.md)
-  - [Creating a C++ Mod](./guides/creating-a-c++-mod.md)
-  - [Installing a C++ Mod](./guides/installing-a-c++-mod.md)
-  - [GUI tabs with a C++ Mod](./guides/creating-gui-tabs-with-c++-mod.md)
-  - [Accessing UE properties with a C++ mod](./guides/accessing-ue-properties-c++.md)
-  - [Creating a Lua Mod](./guides/creating-a-lua-mod.md)
-  - [Using Custom Lua Bindings](./guides/using-custom-lua-bindings.md)
+
 
 ## Misc