From 73e6e77eb7cf20c4f8c8c4129d4d10ec6bf09e44 Mon Sep 17 00:00:00 2001
From: chmod77 <chmod777.ke@gmail.com>
Date: Fri, 29 Nov 2024 18:26:07 +0300
Subject: [PATCH] chore: update docs - include virtual env activation step

Signed-off-by: chmod77 <chmod777.ke@gmail.com>
---
 docs/README.md | 8 ++------
 1 file changed, 2 insertions(+), 6 deletions(-)

diff --git a/docs/README.md b/docs/README.md
index f721a72b8a..a55835c48a 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -14,21 +14,18 @@ For Windows, use irm to download the script and execute it with iex:
 
 ```bash
 powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
-
 powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/0.5.5/install.ps1 | iex"
 ```
 
 To install via PyPi:
 
 ```bash 
-
 pipx install uv
 ```
 
 or  
 
 ```bash 
-
  pip install uv
 ```
 
@@ -36,10 +33,10 @@ or
 ## Setup the build environment
 
 ```bash
+uv venv
+source .venv/bin/activate
 uv sync
-
 uv pip install ./flyteidl
-
 ```
 
 ## Building the docs
@@ -48,7 +45,6 @@ uv pip install ./flyteidl
 export DOCSEARCH_API_KEY=fake-api-key
 export FLYTEKIT_LOCAL_PATH=<PATH_TO_LOCAL_FLYTEKIT_REPO>
 export FLYTESNACKS_LOCAL_PATH=<PATH_TO_LOCAL_FLYTESNACKS_REPO>
-
 uv run make docs
 ```
 The resulting `html` files will be in `docs/_build/html`.
\ No newline at end of file