From 488166f46add13ef988c3c8f3cd91d6221c3f1cd Mon Sep 17 00:00:00 2001 From: Chi-Sheng Liu Date: Tue, 27 Feb 2024 23:55:47 +0800 Subject: [PATCH] docs(monodocs): Update documentation for monodocs local development Signed-off-by: Chi-Sheng Liu --- docs/community/contribute.rst | 16 +++------------- 1 file changed, 3 insertions(+), 13 deletions(-) diff --git a/docs/community/contribute.rst b/docs/community/contribute.rst index e866be5a2c9..cce5f7f6d6e 100644 --- a/docs/community/contribute.rst +++ b/docs/community/contribute.rst @@ -155,20 +155,10 @@ To understand how the below components interact with each other, refer to :ref:` To build the Flyte docs locally you will need the following prerequisites: -* Install ``conda``. - * We recommend Miniconda installed with an `official installer `__. * Install `conda-lock `__. -* In the ``flyteorg/flyte`` root directory run: - * ``conda-lock install --name monodocs-env monodocs-environment.lock.yaml`` - * ``conda activate monodocs-env`` - * ``pip install ./flyteidl`` - -This will set up the Python virtual environment for building the docs. Here we called it ``monodocs-env``. - -To actually build the docs, activate ``monodocs-env`` and (in the ``flyteorg/flyte`` root directory) run: - * ``make docs`` - -The resulting ``html`` files will be in ``docs/_build/html``. You can view them by running `open docs/_build/html/index.html` +* In the ``flyteorg/flyte`` root directory you can run: + * ``make dev-docs-build`` to build the documentation locally. The build will be in the ``docs/_build/html`` directory. + * Alternatively, you can use ``make dev-docs`` to build the documentation with live reload. Open the browser to ``http://localhost:8000`` to see the documentation. ``flyteidl`` ************