Skip to content

Commit

Permalink
Add docs build process readme (#4772)
Browse files Browse the repository at this point in the history
Signed-off-by: Peeter Piegaze <[email protected]>
  • Loading branch information
ppiegaze authored Jan 24, 2024
1 parent 0538efb commit 5e2224a
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Building the Flyte docs locally

## Prerequisites

* `conda` (We recommend Miniconda installed with an [official installer](https://docs.conda.io/projects/miniconda/en/latest/index.html#latest-miniconda-installer-links))

* [`conda-lock`](https://github.com/conda/conda-lock)


## Set up the build environment

In the `flyteorg/flyte` root directory do:

```
$ conda-lock install --name monodocs-env monodocs-environment.lock.yaml
```

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.


## Building the docs

In the `flyteorg/flyte` root directory make sure you have activated the `monodocs-env` (or whatever you called it) environment and do:

```
$ make docs
```

The resulting `html` files will be in `docs/_build/html`.

0 comments on commit 5e2224a

Please sign in to comment.