From 972fb64fe3c69307c120f6f27208786c106b0170 Mon Sep 17 00:00:00 2001 From: Philip May Date: Tue, 8 Feb 2022 19:53:26 +0100 Subject: [PATCH] improve install doc with zsh Signed-off-by: Philip May --- DEVELOPER_GUIDE.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index 10dbb2e7..2fe20198 100644 --- a/DEVELOPER_GUIDE.md +++ b/DEVELOPER_GUIDE.md @@ -29,7 +29,9 @@ Note that integration tests require docker to be installed and running, and down This are the steps to build the documentation with [Sphinx](https://www.sphinx-doc.org/): 1. change into the `opensearch-py` directory where `setup.py` is located -2. install opensearch-py - we recommend [editable mode](https://pip.pypa.io/en/stable/cli/pip_install/#cmdoption-e): `pip install -e .[docs]` -3. change into the `docs` directory -4. execute `make html` -5. use your favorite web browser to open the file called `opensearch-py/docs/build/html/index.html` +2. install opensearch-py - we recommend [editable mode](https://pip.pypa.io/en/stable/cli/pip_install/#cmdoption-e + - with bash: `pip install -e .[docs]` + - with zsh: `pip install -e .\[docs]` +4. change into the `docs` directory +5. execute `make html` +6. use your favorite web browser to open the file called `opensearch-py/docs/build/html/index.html`