Merge pull request #3 from mmacy/examples-add

surface Examples section

Author: mmacy

docs/examples/index.md

@@ -0,0 +1,13 @@
+# Examples
+
+The following examples are taken from the [`examples/`](https://github.com/openai/openai-python/tree/main/examples) directory in the root of the [openai/openai-python](https://github.com/openai/openai-python) repository.
+
+- [assistant.py](./assistant.md)
+- [async_demo.py](./async_demo.md)
+- [audio.py](./audio.md)
+- [azure.py](./azure.md)
+- [azure_ad.py](./azure_ad.md)
+- [demo.py](./demo.md)
+- [module_client.py](./module_client.md)
+- [picture.py](./picture.md)
+- [streaming.py](./streaming.md)

docs/index.md

@@ -4,7 +4,8 @@ Welcome to Marsh's totally unofficial and totally unsupported documentation for
 
 <div class="grid cards" markdown>
 - :material-clock-fast: [Get started with the library](./get_started.md)
-- :fontawesome-brands-python: [OpenAI Python library reference](reference/index.md)
+- :octicons-file-code-16: [Examples](./examples/index.md)
+- :simple-python: [OpenAI Python library reference](reference/index.md)
 </div>
 
 ## About these docs

mkdocs.yml

@@ -119,6 +119,7 @@ nav:
   - Welcome:
     - index.md
     - Get started: get_started.md
+    - Examples: examples/index.md
     - API reference: reference/index.md
   - Get started:
       - get_started.md
@@ -127,5 +128,5 @@ nav:
       - error-handling.md
       - debugging.md
       - advanced.md
-      - Examples: examples/
+  - Examples: examples/
   - API reference: reference/

scripts/gen_examples_md.py

@@ -3,18 +3,21 @@
 import argparse
 import os
 import glob
+from typing import List
 
 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.")
+    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"))
+    py_file_name = ""
+    md_file_links: List[str] = []
 
     for py_file in python_files:
         py_file_name = os.path.basename(py_file)
@@ -26,5 +29,18 @@ def main():
             md_file.write(f"# {py_file_name}\n\n")
             md_file.write(f"```python\n--8<-- \"./examples/{py_file_name}\"\n```")
 
+        md_file_links.append(md_file_name)
+
+    # Create index.md file
+    index_md_path = os.path.join(args.out_dir, "index.md")
+    with open(index_md_path, 'w') as index_md_file:
+        index_md_file.write("# Examples\n\n")
+        index_md_file.write(
+            "The following examples are taken from the [`examples/`](https://github.com/openai/openai-python/tree/main/examples) "
+            "directory in the root of the [openai/openai-python](https://github.com/openai/openai-python) repository.\n\n"
+            )
+        for md_link in sorted(md_file_links):
+            index_md_file.write(f"- [{md_link.replace('.md', '.py')}](./{md_link})\n")
+
 if __name__ == "__main__":
     main()