add auto outline script

Author: rainsonGain

.github/workflows/build_and_deploy_docs.yml

@@ -27,7 +27,8 @@ jobs:
       - name: Build and deploy
         working-directory: readme_assets
         run: |
-          mv ../docs/mkdocs.yml .
           mv ../docs .
+          python docs/outline.py
+          mv docs/mkdocs.yml .
           mkdocs build
           mkdocs gh-deploy --force

docs/install.md docs/Quickstart/install.mddocs/install.md renamed to docs/Quickstart/install.md

@@ -1,13 +1,11 @@
-Welcome to AWorld’s Documentation!
+# Welcome to AWorld’s Documentation!
 
-## Get Started
+## Quickstart
 
-[Installation](./index.md)
+[Installation](Quickstart/install.md)
 
-## Tutorials
-
-[Workflow Construction](Basic%20usage/workflow_construction.md)
+[Workflow Construction](Quickstart/workflow_construction.md)
 
-## Advanced Tutorials
+## Tutorials
 
 ## API

docs/Basic usage/workflow_construction.md docs/Quickstart/workflow_construction.mddocs/Basic usage/workflow_construction.md renamed to docs/Quickstart/workflow_construction.md

@@ -0,0 +1,49 @@
+import os
+from typing import List
+
+import yaml
+
+root = "../docs"
+black_keys = ["index"]
+black_values = ["index.md"]
+
+
+def scan_path(path: str) -> List[dict]:
+    items = scan(path)
+    res = []
+    for k, v in items.items():
+        if k in black_keys and v in black_values:
+            continue
+
+        res.append({k: v})
+    return res
+
+
+def scan(path: str):
+    items = {}
+    for name in sorted(os.listdir(path)):
+        p = os.path.join(path, name)
+        if name.startswith("."):
+            continue
+
+        if os.path.isdir(p):
+            children = scan(p)
+            if children:
+                items[name] = children
+        elif name.endswith(".md"):
+            items[os.path.splitext(name)[0]] = os.path.relpath(p, root).replace(os.sep, "/")
+    return items
+
+
+if __name__ == '__main__':
+    cfg = {
+        "site_name": "AWorld Docs",
+        "site_url": "https://github.com/inclusionAI/AWorld",
+        "repo_url": "https://github.com/inclusionAI/AWorld",
+        "copyright": "inclusionAI",
+        "theme": "readthedocs",
+        "nav": scan_path(root),
+    }
+
+    with open('mkdocs.yml', 'w') as outfile:
+        yaml.safe_dump(cfg, outfile, sort_keys=False, allow_unicode=True)