phoenix-oss/llama-stack
1
0
Fork 0
forked from phoenix-oss/llama-stack-mirror
Code Pull requests Releases Packages 2 Activity Actions

docs: Add missing uv command and clarify website rebuild (#1199)

Browse source 
# What does this PR do?

This fixes the following error:

```
$ make html
/bin/sh: line 1: sphinx-build: command not found
make: *** [Makefile:20: html] Error 127
```

Also clarifies that this command only rebuilds the website without
watching/refreshes.

## Test Plan

New command works.

---------

Signed-off-by: Yuan Tang <terrytangyuan@gmail.com>
This commit is contained in:
Yuan Tang 2025-02-21 11:29:32 -05:00 • committed by GitHub
parent 9898589f12
commit 6634864b19
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 4 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

6
CONTRIBUTING.md
View file

@ -134,9 +134,11 @@ If you are making changes to the documentation at [https://llama-stack.readthedo
$ cd llama-stack/docs $ cd llama-stack/docs
$ uv sync --extra docs $ uv sync --extra docs
# This rebuilds the documentation pages.
$ uv run make html
# This will start a local server (usually at http://127.0.0.1:8000) that automatically rebuilds and refreshes when you make changes to the documentation. # This will start a local server (usually at http://127.0.0.1:8000) that automatically rebuilds and refreshes when you make changes to the documentation.
$ make html $ uv run sphinx-autobuild source build/html --write-all
$ uv run sphinx-autobuild source build/html
``` ```
### Update API Documentation ### Update API Documentation