From 6634864b196da80c98a324a07cc35e288022107c Mon Sep 17 00:00:00 2001 From: Yuan Tang Date: Fri, 21 Feb 2025 11:29:32 -0500 Subject: [PATCH] docs: Add missing uv command and clarify website rebuild (#1199) # 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 --- CONTRIBUTING.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c5952c8d2..1e4a88f13 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -134,9 +134,11 @@ If you are making changes to the documentation at [https://llama-stack.readthedo $ cd llama-stack/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. -$ make html -$ uv run sphinx-autobuild source build/html +$ uv run sphinx-autobuild source build/html --write-all ``` ### Update API Documentation