Skip to content

Commit

Permalink
chore: update docs - include virtual env activation step
Browse files Browse the repository at this point in the history
  • Loading branch information
chmod77 committed Nov 29, 2024
1 parent 708bad8 commit a99e3e5
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,32 +14,29 @@ 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
```


## Setup the build environment

```bash
uv venv
source .venv/bin/activate
uv sync

uv pip install ./flyteidl

```

## Building the docs
Expand All @@ -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`.

0 comments on commit a99e3e5

Please sign in to comment.