From fd7ab37c14ec80a4b0e05e3bcdd4e7fb824d4e81 Mon Sep 17 00:00:00 2001 From: raghotham Date: Sat, 5 Apr 2025 14:21:45 -0700 Subject: [PATCH] docs: fixing sphinx imports (#1884) # What does this PR do? [Provide a short summary of what this PR does and why. Link to relevant issues if applicable.] [//]: # (If resolving an issue, uncomment and update the line below) [//]: # (Closes #[issue-number]) ## Test Plan [Describe the tests you ran to verify your changes with result summaries. *Provide clear instructions so the plan can be easily re-executed.*] [//]: # (## Documentation) --- docs/readme.md | 8 ++++++++ docs/requirements.txt | 6 ++++-- docs/source/getting_started/index.md | 3 +-- 3 files changed, 13 insertions(+), 4 deletions(-) diff --git a/docs/readme.md b/docs/readme.md index 82bf783ba..b88a4738d 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -2,6 +2,14 @@ Here's a collection of comprehensive guides, examples, and resources for building AI applications with Llama Stack. For the complete documentation, visit our [ReadTheDocs page](https://llama-stack.readthedocs.io/en/latest/index.html). +## Render locally +```bash +pip install -r requirements.txt +cd docs +python -m sphinx_autobuild source _build +``` +You can open up the docs in your browser at http://localhost:8000 + ## Content Try out Llama Stack's capabilities through our detailed Jupyter notebooks: diff --git a/docs/requirements.txt b/docs/requirements.txt index c7c853ff3..e31d08ff1 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -3,10 +3,12 @@ myst-parser linkify -e git+https://github.com/pytorch/pytorch_sphinx_theme.git#egg=pytorch_sphinx_theme sphinx-rtd-theme>=1.0.0 -sphinx-pdj-theme +sphinx_autobuild sphinx-copybutton -sphinx-tabs sphinx-design +sphinx-pdj-theme +sphinx_rtd_dark_mode +sphinx-tabs sphinxcontrib-openapi sphinxcontrib-redoc sphinxcontrib-mermaid diff --git a/docs/source/getting_started/index.md b/docs/source/getting_started/index.md index c6d8ab3dc..ef258a9cf 100644 --- a/docs/source/getting_started/index.md +++ b/docs/source/getting_started/index.md @@ -24,7 +24,7 @@ If you do not have ollama, you can install it from [here](https://ollama.com/dow We use `uv` to setup a virtual environment and install the Llama Stack package. -:::{dropdown} Instructions to setup uv +:::{dropdown} [Click to Open] Instructions to setup uv Install [uv](https://docs.astral.sh/uv/) to setup your virtual environment. @@ -33,7 +33,6 @@ Install [uv](https://docs.astral.sh/uv/) to setup your virtual environment. ```bash curl -LsSf https://astral.sh/uv/install.sh | sh ``` - #### For Windows: Use `irm` to download the script and execute it with `iex`: ```powershell