Several documentation fixes and fix link to API reference

This commit is contained in:
Ashwin Bharambe 2025-02-04 14:00:27 -08:00
parent 26aef50bc5
commit d67401c644
10 changed files with 12 additions and 30 deletions

View file

@ -12,3 +12,7 @@
.wy-side-nav-search { .wy-side-nav-search {
background-color: transparent !important; background-color: transparent !important;
} }
.hide-title h1 {
display: none;
}

View file

@ -29,4 +29,5 @@ fi
stack_dir=$(dirname $(dirname $THIS_DIR)) stack_dir=$(dirname $(dirname $THIS_DIR))
models_dir=$(dirname $stack_dir)/llama-models models_dir=$(dirname $stack_dir)/llama-models
PYTHONPATH=$PYTHONPATH:$stack_dir:$models_dir python -m docs.openapi_generator.generate $(dirname $THIS_DIR)/resources PYTHONPATH=$PYTHONPATH:$stack_dir:$models_dir \
python -m docs.openapi_generator.generate $(dirname $THIS_DIR)/_static

View file

@ -62,10 +62,3 @@ While there is a lot of flexibility to mix-and-match providers, often users will
**On-device Distro**: Finally, you may want to run Llama Stack directly on an edge device (mobile phone or a tablet.) We provide Distros for iOS and Android (coming soon.) **On-device Distro**: Finally, you may want to run Llama Stack directly on an edge device (mobile phone or a tablet.) We provide Distros for iOS and Android (coming soon.)
```{toctree}
:maxdepth: 1
:hidden:
distributions/index
```

View file

@ -68,6 +68,7 @@ myst_substitutions = {
"docker_hub": "https://hub.docker.com/repository/docker/llamastack", "docker_hub": "https://hub.docker.com/repository/docker/llamastack",
} }
suppress_warnings = ['myst.header']
# Copy button settings # Copy button settings
copybutton_prompt_text = "$ " # for bash prompts copybutton_prompt_text = "$ " # for bash prompts
@ -94,22 +95,6 @@ html_static_path = ["../_static"]
# html_logo = "../_static/llama-stack-logo.png" # html_logo = "../_static/llama-stack-logo.png"
html_style = "../_static/css/my_theme.css" html_style = "../_static/css/my_theme.css"
redoc = [
{
"name": "Llama Stack API",
"page": "references/api_reference/index",
"spec": "../resources/llama-stack-spec.yaml",
"opts": {
"suppress-warnings": True,
# "expand-responses": ["200", "201"],
},
"embed": True,
},
]
redoc_uri = "https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"
def setup(app): def setup(app):
def dockerhub_role(name, rawtext, text, lineno, inliner, options={}, content=[]): def dockerhub_role(name, rawtext, text, lineno, inliner, options={}, content=[]):
url = f"https://hub.docker.com/r/llamastack/{text}" url = f"https://hub.docker.com/r/llamastack/{text}"

View file

@ -43,7 +43,6 @@ self_hosted_distro/nvidia
self_hosted_distro/ollama self_hosted_distro/ollama
self_hosted_distro/together self_hosted_distro/together
self_hosted_distro/fireworks self_hosted_distro/fireworks
ondevice_distro/index
``` ```
### On-Device Distributions ### On-Device Distributions

View file

@ -1,3 +1,4 @@
```{admonition} News ```{admonition} News
:class: tip :class: tip

View file

@ -1,7 +1,6 @@
{.hide-title}
# API Reference # API Reference
```{eval-rst} ```{raw} html
.. sphinxcontrib-redoc:: ../resources/llama-stack-spec.yaml :file: ../../../_static/llama-stack-spec.html
:page-title: API Reference
:expand-responses: all
``` ```

View file

@ -12,7 +12,7 @@ This guide goes over the sets of APIs and developer experience flow of using Lla
## Evaluation Concepts ## Evaluation Concepts
The Evaluation APIs are associated with a set of Resources as shown in the following diagram. Please visit the Resources section in our [Core Concepts](../concepts/index.md) guide for better high-level understanding. The Evaluation APIs are associated with a set of Resources as shown in the following diagram. Please visit the Resources section in our [Core Concepts](../../concepts/index.md) guide for better high-level understanding.
![Eval Concepts](./resources/eval-concept.png) ![Eval Concepts](./resources/eval-concept.png)