phoenix-oss/llama-stack-mirror
0
0
Fork 1
mirror of https://github.com/meta-llama/llama-stack.git synced 2025-10-22 16:23:08 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: update docstrings for better formatting (#3838)

Browse source 
# What does this PR do?
Updates docstrings for Conversations and Eval APIs to render better in
the docs nav sidebar.

Before: 
<img width="363" height="233" alt="Screenshot 2025-10-17 at 9 52 17 AM"
src="https://github.com/user-attachments/assets/3a77f9e3-3b03-43ae-8584-a21d1f44d54d"
/>

After:
<img width="410" height="206" alt="Screenshot 2025-10-17 at 9 52 11 AM"
src="https://github.com/user-attachments/assets/fa5d428d-2bde-4453-84fd-9aceebe712e8"
/>


## Test Plan
* Manual testing
This commit is contained in:
Alexey Rybak 2025-10-17 10:41:50 -07:00 • committed by GitHub
parent c9f0bebcb7
commit 224c99560c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
11 changed files with 159 additions and 91 deletions
Download patch file Download diff file Expand all files Collapse all files

38
docs/static/stainless-llama-stack-spec.html vendored
View file

@ -282,7 +282,7 @@
"Conversations"
],
"summary": "Create a conversation.",
"description": "Create a conversation.",
"description": "Create a conversation.\nCreate a conversation.",
"parameters": [],
"requestBody": {
"content": {
@ -326,8 +326,8 @@
"tags": [
"Conversations"
],
"summary": "Get a conversation with the given ID.",
"description": "Get a conversation with the given ID.",
"summary": "Retrieve a conversation.",
"description": "Retrieve a conversation.\nGet a conversation with the given ID.",
"parameters": [
{
"name": "conversation_id",
@ -369,8 +369,8 @@
"tags": [
"Conversations"
],
"summary": "Update a conversation's metadata with the given ID.",
"description": "Update a conversation's metadata with the given ID.",
"summary": "Update a conversation.",
"description": "Update a conversation.\nUpdate a conversation's metadata with the given ID.",
"parameters": [
{
"name": "conversation_id",
@ -422,8 +422,8 @@
"tags": [
"Conversations"
],
"summary": "Delete a conversation with the given ID.",
"description": "Delete a conversation with the given ID.",
"summary": "Delete a conversation.",
"description": "Delete a conversation.\nDelete a conversation with the given ID.",
"parameters": [
{
"name": "conversation_id",
@ -467,8 +467,8 @@
"tags": [
"Conversations"
],
"summary": "List items in the conversation.",
"description": "List items in the conversation.",
"summary": "List items.",
"description": "List items.\nList items in the conversation.",
"parameters": [
{
"name": "conversation_id",
@ -597,8 +597,8 @@
"tags": [
"Conversations"
],
"summary": "Create items in the conversation.",
"description": "Create items in the conversation.",
"summary": "Create items.",
"description": "Create items.\nCreate items in the conversation.",
"parameters": [
{
"name": "conversation_id",
@ -652,8 +652,8 @@
"tags": [
"Conversations"
],
"summary": "Retrieve a conversation item.",
"description": "Retrieve a conversation item.",
"summary": "Retrieve an item.",
"description": "Retrieve an item.\nRetrieve a conversation item.",
"parameters": [
{
"name": "conversation_id",
@ -704,8 +704,8 @@
"tags": [
"Conversations"
],
"summary": "Delete a conversation item.",
"description": "Delete a conversation item.",
"summary": "Delete an item.",
"description": "Delete an item.\nDelete a conversation item.",
"parameters": [
{
"name": "conversation_id",
@ -17928,8 +17928,8 @@
},
{
"name": "Conversations",
"description": "",
"x-displayName": "Protocol for conversation management operations."
"description": "Protocol for conversation management operations.",
"x-displayName": "Conversations"
},
{
"name": "DatasetIO",
@ -17941,8 +17941,8 @@
},
{
"name": "Eval",
"description": "",
"x-displayName": "Llama Stack Evaluation API for running evaluations on model and agent candidates."
"description": "Llama Stack Evaluation API for running evaluations on model and agent candidates.",
"x-displayName": "Evaluations"
},
{
"name": "Files",