发布

  • [NA] [DOCS] [SDK] Render empty integration reference pages & fix docstring build errors (#7571)

    frostbyte_neo 发布于 2026-07-22 17:03:21 +00:00

    • fix(python-sdk-docs): mock integration libraries so reference pages render

    autodoc imports each opik.integrations.* module to document it, but several
    of their third-party SDKs crash on import in the docs build (google-genai and
    litellm raise PydanticSchemaGenerationError), so every integration reference
    page deployed empty (0 signature blocks vs 81 on Opik.html).

    Add autodoc_mock_imports for the integration-only third-party libraries so
    autodoc documents the opik wrappers without importing the real SDKs. This
    recovers the openai / anthropic / crewai / dspy / guardrails / llama_index /
    haystack / bedrock / genai pages. (adk and langchain still fail for unrelated
    reasons - opik's own adk version check and a langchain_core import - and are
    left for a follow-up.)

    Co-Authored-By: Claude Opus 4.8 (1M context) noreply@anthropic.com

    • fix(python-sdk): fix docstring bullet lists that broke Sphinx rendering

    Several docstrings placed an indented bullet sub-list directly under a line
    ending in ":" with no blank line and a non-RST "•" marker, which docutils
    reports as "Unexpected indentation" (a build ERROR) and renders broken:

    • evaluate / evaluate_experiment / evaluate_prompt (evaluator.py): the
      "arguments supplied by the evaluation engine" list
    • track_openai (openai integration): the "Tracks calls to" list

    Add the blank line and use valid "-" markers so they render as bullet lists.
    Clears all 3 docutils ERRORs from the docs build.

    Co-Authored-By: Claude Opus 4.8 (1M context) noreply@anthropic.com


    Co-authored-by: Claude Opus 4.8 (1M context) noreply@anthropic.com

    下载附件