diff --git a/.readthedocs.yaml b/.readthedocs.yaml index f94476ff3..8447c9741 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -11,7 +11,7 @@ build: jobs: post_install: - pip install uv - - UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH uv sync --group docs --all-extras --no-extra krisp --no-extra gstreamer + - UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH uv sync --group docs --all-extras --no-extra krisp --no-extra gstreamer --no-extra ultravox --no-extra local_smart_turn --no-extra moondream --no-extra riva --no-extra mlx-whisper sphinx: configuration: docs/api/conf.py diff --git a/docs/api/build-docs.sh b/docs/api/build-docs.sh index 800a1cfad..d997f763e 100755 --- a/docs/api/build-docs.sh +++ b/docs/api/build-docs.sh @@ -2,7 +2,7 @@ # Build docs using uv echo "Installing dependencies with uv..." -uv sync --group docs --all-extras --no-extra krisp --no-extra gstreamer +uv sync --group docs --all-extras --no-extra krisp --no-extra gstreamer --no-extra ultravox --no-extra local_smart_turn --no-extra moondream --no-extra riva --no-extra mlx-whisper # Check if sphinx-build is available if ! uv run sphinx-build --version &> /dev/null; then diff --git a/docs/api/conf.py b/docs/api/conf.py index 652ca2af9..a3062b612 100644 --- a/docs/api/conf.py +++ b/docs/api/conf.py @@ -45,7 +45,7 @@ autodoc_default_options = { "show-inheritance": True, } -# Mock imports for problematic dependencies only +# Mock imports for optional dependencies autodoc_mock_imports = [ # Krisp - has build issues on some platforms "pipecat_ai_krisp", @@ -54,10 +54,45 @@ autodoc_mock_imports = [ "_tkinter", "tkinter", # Platform-specific audio libraries (if needed) - # gstreamer "gi", "gi.require_version", "gi.repository", + # OpenCV - sometimes has import issues during docs build + "cv2", + # Heavy ML packages excluded from ReadTheDocs + # ultravox dependencies + "vllm", + "vllm.engine.arg_utils", + # local-smart-turn dependencies + "coremltools", + "coremltools.models", + "coremltools.models.MLModel", + "torch", + "torch.nn", + "torch.nn.functional", + "torchaudio", + # moondream dependencies + "transformers", + "transformers.AutoTokenizer", + "transformers.AutoFeatureExtractor", + "AutoFeatureExtractor", + "timm", + "einops", + "intel_extension_for_pytorch", + "huggingface_hub", + # riva dependencies + "riva", + "riva.client", + "riva.client.Auth", + "riva.client.ASRService", + "riva.client.StreamingRecognitionConfig", + "riva.client.RecognitionConfig", + "riva.client.AudioEncoding", + "riva.client.proto.riva_tts_pb2", + "riva.client.SpeechSynthesisService", + # MLX dependencies (Apple Silicon specific) + "mlx", + "mlx_whisper", # Note: might need underscore format too ] # HTML output settings