add notes about batches development status to docs

this also captures other notes from agents, eval and inference apis
This commit is contained in:
Matthew Farrellee 2025-08-13 07:15:07 -04:00
parent 8e678912ec
commit 04a73c89ef
7 changed files with 56 additions and 1 deletions

View file

@ -18,6 +18,23 @@ from llama_stack.core.distribution import get_provider_registry
REPO_ROOT = Path(__file__).parent.parent
def get_api_docstring(api_name: str) -> str | None:
"""Extract docstring from the API protocol class."""
try:
# Import the API module dynamically
api_module = __import__(f"llama_stack.apis.{api_name}", fromlist=[api_name.title()])
# Get the main protocol class (usually capitalized API name)
protocol_class_name = api_name.title()
if hasattr(api_module, protocol_class_name):
protocol_class = getattr(api_module, protocol_class_name)
return protocol_class.__doc__
except (ImportError, AttributeError):
pass
return None
class ChangedPathTracker:
"""Track a list of paths we may have changed."""
@ -261,6 +278,11 @@ def process_provider_registry(progress, change_tracker: ChangedPathTracker) -> N
index_content.append(f"# {api_name.title()}\n")
index_content.append("## Overview\n")
api_docstring = get_api_docstring(api_name)
if api_docstring:
cleaned_docstring = api_docstring.strip()
index_content.append(f"{cleaned_docstring}\n")
index_content.append(
f"This section contains documentation for all available providers for the **{api_name}** API.\n"
)