Move PX4 Guide source into /docs (#24490)

* Add vitepress tree * Update existing workflows so they dont trigger on changes in the docs path * Add nojekyll, package.json, LICENCE etc * Add crowdin docs upload/download scripts * Add docs flaw checker workflows * Used docs prefix for docs workflows * Crowdin obvious fixes * ci: docs move to self hosted runner runs on a beefy server for faster builds Signed-off-by: Ramon Roche <mrpollo@gmail.com> * ci: don't run build action for docs or ci changes Signed-off-by: Ramon Roche <mrpollo@gmail.com> * ci: update runners Signed-off-by: Ramon Roche <mrpollo@gmail.com> * Add docs/en * Add docs assets and scripts * Fix up editlinks to point to PX4 sources * Download just the translations that are supported * Add translation sources for zh, uk, ko * Update latest tranlsation and uorb graphs * update vitepress to latest --------- Signed-off-by: Ramon Roche <mrpollo@gmail.com> Co-authored-by: Ramon Roche <mrpollo@gmail.com>
2026-10-18 07:23:34 +08:00 · 2025-03-13 16:08:27 +11:00
parent 8e6d2ebe4a
commit 88d623bedb
5176 changed files with 558771 additions and 2 deletions
@@ -0,0 +1,44 @@
+#! /usr/bin/python
+
+"""
+Generates a file _sidebar.md for each SUMMARY.md in the immediate folders (e.g. /en/SUMMARY.md)
+This is stored in github. Can be called at build time to create/deploy for docsify builds.
+Note, we don't "support" docsify - this is experimental
+"""
+import os
+import re
+
+
+def modify_summary_links(directory):
+    # Iterate over all immediate subdirectories
+    for subdir in next(os.walk(directory))[1]:
+        summary_md_path = os.path.join(directory, subdir, 'SUMMARY.md')
+        # Check if SUMMARY.md exists in the subdirectory
+        if os.path.isfile(summary_md_path):
+            # print(f"Processing: {summary_md_path}")
+            # Read the SUMMARY.md content
+            with open(summary_md_path, 'r', encoding='utf-8') as f:
+                summary_content = f.read()
+
+            # Modify the URLs to start with '/'
+            modified_content = re.sub(r'\]\((?!/)', '](/', summary_content)
+
+            # Add generated disclaimer
+            disclaimer = "<!-- GENERATED CONTENT: DO NOT EDIT -->\n"
+            modified_content = disclaimer + modified_content
+            # Create the output file path
+            output_path = os.path.join(directory, subdir, '_sidebar.md')
+
+            # Write the modified content to the output file
+            with open(output_path, 'w', encoding='utf-8') as f:
+                f.write(modified_content)
+
+            # print(f"Modified SUMMARY.md saved as {output_path}")
+
+
+if __name__ == "__main__":
+    # Specify the directory to search for SUMMARY.md files
+    specified_directory = "."
+
+    # Call the function to modify SUMMARY.md links in all subdirectories
+    modify_summary_links(specified_directory)