Move API docs generation to docs/api

2024-12-09 20:39:29 -05:00
parent 61d0fa42f1
commit 2d3864ee09
30 changed files with 18 additions and 17 deletions
--- a/docs/api/generate_docs.py
+++ b/docs/api/generate_docs.py
@@ -0,0 +1,104 @@
+#!/usr/bin/env python3
+
+import shutil
+import subprocess
+from pathlib import Path
+
+
+def run_command(command: list[str]) -> None:
+    """Run a command and exit if it fails."""
+    print(f"Running: {' '.join(command)}")
+    try:
+        subprocess.run(command, check=True)
+    except subprocess.CalledProcessError as e:
+        print(f"Warning: Command failed: {' '.join(command)}")
+        print(f"Error: {e}")
+
+
+def main():
+    docs_dir = Path(__file__).parent
+    project_root = docs_dir.parent.parent
+
+    # Install documentation requirements
+    requirements_file = docs_dir / "requirements.txt"
+    run_command(["pip", "install", "-r", str(requirements_file)])
+
+    # Install from project root, not docs directory
+    run_command(["pip", "install", "-e", str(project_root)])
+
+    # Install all service dependencies
+    services = [
+        "anthropic",
+        "assemblyai",
+        "aws",
+        "azure",
+        "canonical",
+        "cartesia",
+        # "daily",
+        "deepgram",
+        "elevenlabs",
+        "fal",
+        "fireworks",
+        "gladia",
+        "google",
+        "grok",
+        "groq",
+        "langchain",
+        # "livekit",
+        "lmnt",
+        "moondream",
+        "nim",
+        "noisereduce",
+        "openai",
+        "openpipe",
+        "playht",
+        "silero",
+        "soundfile",
+        "websocket",
+        "whisper",
+    ]
+
+    extras = ",".join(services)
+    try:
+        run_command(["pip", "install", "-e", f"{str(project_root)}[{extras}]"])
+    except Exception as e:
+        print(f"Warning: Some dependencies failed to install: {e}")
+
+    # Clean old files
+    api_dir = docs_dir / "api"
+    build_dir = docs_dir / "_build"
+    for dir in [api_dir, build_dir]:
+        if dir.exists():
+            shutil.rmtree(dir)
+
+    # Generate API documentation
+    run_command(
+        [
+            "sphinx-apidoc",
+            "-f",  # Force overwrite
+            "-e",  # Put each module on its own page
+            "-M",  # Put module documentation before submodule
+            "--no-toc",  # Don't generate modules.rst (cleaner structure)
+            "-o",
+            str(api_dir),  # Output directory
+            str(project_root / "src/pipecat"),
+            # Exclude problematic files and directories
+            str(project_root / "src/pipecat/processors/gstreamer"),  # Optional gstreamer
+            str(project_root / "src/pipecat/transports/network"),  # Pydantic issues
+            str(project_root / "src/pipecat/transports/services"),  # Pydantic issues
+            str(project_root / "src/pipecat/transports/local"),  # Optional dependencies
+            str(project_root / "src/pipecat/services/to_be_updated"),  # Exclude to_be_updated
+            "**/test_*.py",  # Test files
+            "**/tests/*.py",  # Test files
+        ]
+    )
+
+    # Build HTML documentation
+    run_command(["sphinx-build", "-b", "html", str(docs_dir), str(build_dir / "html")])
+
+    print("\nDocumentation generated successfully!")
+    print(f"HTML docs: {build_dir}/html/index.html")
+
+
+if __name__ == "__main__":
+    main()