docs: fix warnings in documentation generation

This commit is contained in:
Kelly Brown 2025-07-22 15:16:26 -04:00
parent e1ed152779
commit 04659df79d
77 changed files with 286 additions and 106 deletions

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# inline::meta-reference
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::nvidia
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# inline::huggingface
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# inline::torchtune
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::nvidia
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# inline::basic
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# inline::braintrust
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# inline::llm-as-judge
## Description

View file

@ -11,4 +11,5 @@ See the [Adding a New API Provider](new_api_provider.md) which describes how to
:hidden:
new_api_provider
testing
```

View file

@ -9,6 +9,7 @@ This section provides an overview of the distributions available in Llama Stack.
list_of_distributions
building_distro
customizing_run_yaml
starting_llama_stack_server
importing_as_library
configuration
```

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# inline::meta-reference
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# inline::localfs
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::huggingface
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::nvidia
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# inline::meta-reference
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::nvidia
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# inline::localfs
## Description

View file

@ -89,4 +89,14 @@ Is associated with the ToolGroup resources.
:maxdepth: 1
tool_runtime/index
```
```
## Files Providers
Is associated with the **files** APIs
```{toctree}
:maxdepth: 1
files/index
```

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# inline::meta-reference
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# inline::sentence-transformers
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::anthropic
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::bedrock
## Description

View file

@ -1,21 +0,0 @@
# remote::cerebras-openai-compat
## Description
Cerebras OpenAI-compatible provider for using Cerebras models with OpenAI API format.
## Configuration
| Field | Type | Required | Default | Description |
|-------|------|----------|---------|-------------|
| `api_key` | `str \| None` | No | | The Cerebras API key |
| `openai_compat_api_base` | `<class 'str'>` | No | https://api.cerebras.ai/v1 | The URL for the Cerebras API server |
## Sample Configuration
```yaml
openai_compat_api_base: https://api.cerebras.ai/v1
api_key: ${env.CEREBRAS_API_KEY}
```

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::cerebras
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::databricks
## Description

View file

@ -1,21 +0,0 @@
# remote::fireworks-openai-compat
## Description
Fireworks AI OpenAI-compatible provider for using Fireworks models with OpenAI API format.
## Configuration
| Field | Type | Required | Default | Description |
|-------|------|----------|---------|-------------|
| `api_key` | `str \| None` | No | | The Fireworks API key |
| `openai_compat_api_base` | `<class 'str'>` | No | https://api.fireworks.ai/inference/v1 | The URL for the Fireworks API server |
## Sample Configuration
```yaml
openai_compat_api_base: https://api.fireworks.ai/inference/v1
api_key: ${env.FIREWORKS_API_KEY}
```

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::fireworks
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::gemini
## Description

View file

@ -1,21 +0,0 @@
# remote::groq-openai-compat
## Description
Groq OpenAI-compatible provider for using Groq models with OpenAI API format.
## Configuration
| Field | Type | Required | Default | Description |
|-------|------|----------|---------|-------------|
| `api_key` | `str \| None` | No | | The Groq API key |
| `openai_compat_api_base` | `<class 'str'>` | No | https://api.groq.com/openai/v1 | The URL for the Groq API server |
## Sample Configuration
```yaml
openai_compat_api_base: https://api.groq.com/openai/v1
api_key: ${env.GROQ_API_KEY}
```

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::groq
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::hf::endpoint
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::hf::serverless
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::llama-openai-compat
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::nvidia
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::ollama
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::openai
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::passthrough
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::runpod
## Description

View file

@ -1,21 +0,0 @@
# remote::sambanova-openai-compat
## Description
SambaNova OpenAI-compatible provider for using SambaNova models with OpenAI API format.
## Configuration
| Field | Type | Required | Default | Description |
|-------|------|----------|---------|-------------|
| `api_key` | `str \| None` | No | | The SambaNova API key |
| `openai_compat_api_base` | `<class 'str'>` | No | https://api.sambanova.ai/v1 | The URL for the SambaNova API server |
## Sample Configuration
```yaml
openai_compat_api_base: https://api.sambanova.ai/v1
api_key: ${env.SAMBANOVA_API_KEY}
```

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::sambanova
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::tgi
## Description

View file

@ -1,21 +0,0 @@
# remote::together-openai-compat
## Description
Together AI OpenAI-compatible provider for using Together models with OpenAI API format.
## Configuration
| Field | Type | Required | Default | Description |
|-------|------|----------|---------|-------------|
| `api_key` | `str \| None` | No | | The Together API key |
| `openai_compat_api_base` | `<class 'str'>` | No | https://api.together.xyz/v1 | The URL for the Together API server |
## Sample Configuration
```yaml
openai_compat_api_base: https://api.together.xyz/v1
api_key: ${env.TOGETHER_API_KEY}
```

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::together
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::vllm
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::watsonx
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# inline::huggingface
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# inline::torchtune
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::nvidia
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# inline::code-scanner
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# inline::llama-guard
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# inline::prompt-guard
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::bedrock
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::nvidia
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::sambanova
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# inline::basic
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# inline::braintrust
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# inline::llm-as-judge
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# inline::meta-reference
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# inline::rag-runtime
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::bing-search
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::brave-search
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::model-context-protocol
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::tavily-search
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::wolfram-alpha
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# inline::chromadb
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# inline::faiss
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# inline::meta-reference
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# inline::milvus
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# inline::qdrant
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# inline::sqlite-vec
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# inline::sqlite_vec
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::chromadb
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::milvus
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::pgvector
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::qdrant
## Description

View file

@ -1,3 +1,7 @@
---
orphan: true
---
# remote::weaviate
## Description

View file

@ -145,6 +145,7 @@ def generate_provider_docs(provider_spec: Any, api_name: str) -> str:
config_info = get_config_class_info(config_class)
md_lines = []
md_lines.append("---\norphan: true\n---\n")
md_lines.append(f"# {provider_type}")
md_lines.append("")