-
Notifications
You must be signed in to change notification settings - Fork 674
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add docs build process readme (#4772)
Signed-off-by: Peeter Piegaze <[email protected]>
- Loading branch information
Showing
1 changed file
with
29 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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`. |