From 9dd6a870a031568dbe278bf073cc4fc0deb62ae5 Mon Sep 17 00:00:00 2001 From: Sergiy Popovych Date: Thu, 30 Nov 2023 00:59:44 +0000 Subject: [PATCH] chore: update docs with `recurse-submodules` --- docs/source/index.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 49e286264..34774d29c 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -22,7 +22,15 @@ The recommended installation method is `pip `_-i .. code-block:: console - $ git clone git@github.com:ZettaAI/zetta_utils.git + $ git clone git@github.com:ZettaAI/zetta_utils.git + $ cd zetta_utils + $ pip install -e '.[all]' + +If you are a member of the Zetta team and have access to private submodules, instead do: + +.. code-block:: console + + $ git clone --recurse-submodules git@github.com:ZettaAI/zetta_utils.git $ cd zetta_utils $ pip install -e '.[all]'