actions/opensearch-pyd
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

improve install doc with zsh

Browse Source 
Signed-off-by: Philip May <philip@may.la>
This commit is contained in:
Philip May
2022-02-08 19:53:26 +01:00
committed by Vijayan Balasubramanian
parent 19be5802ea
commit 972fb64fe3
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
DEVELOPER_GUIDE.md
+6 -4
View File
@@ -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`