Merge pull request #2 from mmacy/examples-add

autogen examples pages

Author: mmacy

docs/connect.md

@@ -1,3 +1,9 @@
 # Connect
 
---8<-- "./README.md:connect"
+--8<-- "./README.md:connect"
+
+## Examples
+
+```python
+--8<-- "./examples/demo.py"
+```

docs/examples/assistant.md

@@ -0,0 +1,5 @@
+# assistant.py
+
+```python
+--8<-- "./examples/assistant.py"
+```

docs/examples/async_demo.md

@@ -0,0 +1,5 @@
+# async_demo.py
+
+```python
+--8<-- "./examples/async_demo.py"
+```

docs/examples/audio.md

@@ -0,0 +1,5 @@
+# audio.py
+
+```python
+--8<-- "./examples/audio.py"
+```

docs/examples/azure.md

@@ -0,0 +1,5 @@
+# azure.py
+
+```python
+--8<-- "./examples/azure.py"
+```

docs/examples/azure_ad.md

@@ -0,0 +1,5 @@
+# azure_ad.py
+
+```python
+--8<-- "./examples/azure_ad.py"
+```

docs/examples/demo.md

@@ -0,0 +1,5 @@
+# demo.py
+
+```python
+--8<-- "./examples/demo.py"
+```

docs/examples/module_client.md

@@ -0,0 +1,5 @@
+# module_client.py
+
+```python
+--8<-- "./examples/module_client.py"
+```

docs/examples/picture.md

@@ -0,0 +1,5 @@
+# picture.py
+
+```python
+--8<-- "./examples/picture.py"
+```

docs/examples/streaming.md

@@ -0,0 +1,5 @@
+# streaming.py
+
+```python
+--8<-- "./examples/streaming.py"
+```

mkdocs.yml

@@ -80,7 +80,7 @@ plugins:
       handlers:
         python:
           paths: [src]
-          load_external_modules: true # 'true' picks up __all__ from __init__.py files
+          load_external_modules: false # 'true' picks up __all__ from __init__.py files
           import:
             - https://docs.python.org/3/objects.inv
             - https://docs.pydantic.dev/2.4/objects.inv
@@ -127,4 +127,5 @@ nav:
       - error-handling.md
       - debugging.md
       - advanced.md
+      - Examples: examples/
   - API reference: reference/

scripts/gen_examples_md.py

@@ -0,0 +1,30 @@
+#!/usr/bin/env python3
+
+import argparse
+import os
+import glob
+
+def main():
+    parser = argparse.ArgumentParser(description="Generate Markdown files for Python scripts.")
+    parser.add_argument("--dir", "-d", default="./examples", help="Directory to search for Python files.")
+    parser.add_argument("--out-dir", "-o", default="./docs/examples", help="Directory to output Markdown files.")
+    args = parser.parse_args()
+
+    # Ensure output directory exists
+    os.makedirs(args.out_dir, exist_ok=True)
+
+    # Get list of *.py files in the specified directory
+    python_files = glob.glob(os.path.join(args.dir, "*.py"))
+
+    for py_file in python_files:
+        py_file_name = os.path.basename(py_file)
+        md_file_name = os.path.splitext(py_file_name)[0] + ".md"
+        md_file_path = os.path.join(args.out_dir, md_file_name)
+
+        # Create and write to the corresponding *.md file
+        with open(md_file_path, 'w') as md_file:
+            md_file.write(f"# {py_file_name}\n\n")
+            md_file.write(f"```python\n--8<-- \"./examples/{py_file_name}\"\n```")
+
+if __name__ == "__main__":
+    main()