From b464a65666cb57bcf39aad17fba2faacaf46d020 Mon Sep 17 00:00:00 2001 From: Niels Bantilan Date: Thu, 1 Feb 2024 14:21:39 -0500 Subject: [PATCH] update docs README environment setup Signed-off-by: Niels Bantilan --- Makefile | 4 ---- docs/README.md | 6 ++++-- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/Makefile b/Makefile index ffc33ebe23..7bcc6e8cf8 100644 --- a/Makefile +++ b/Makefile @@ -53,10 +53,6 @@ deploy_sandbox: install-piptools: ## Install pip-tools pip install -U pip-tools -.PHONY: doc-requirements.txt -doc-requirements.txt: doc-requirements.in install-piptools - $(call PIP_COMPILE,doc-requirements.in) - .PHONY: install-conda-lock install-conda-lock: pip install conda-lock diff --git a/docs/README.md b/docs/README.md index 322c7fe3b5..dc5cb7046c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -11,8 +11,10 @@ In the `flyteorg/flyte` root directory do: -``` +```bash $ conda-lock install --name monodocs-env monodocs-environment.lock.yaml +$ conda activate monodocs-env +$ pip install ./flyteidl ``` This creates a new environment called `monodocs-env` with all the dependencies needed to build the docs. You can choose a different environment name if you like. @@ -22,7 +24,7 @@ This creates a new environment called `monodocs-env` with all the dependencies n In the `flyteorg/flyte` root directory make sure you have activated the `monodocs-env` (or whatever you called it) environment and do: -``` +```bash $ make docs ```