Skip to content

Commit 261f9e1

Browse files
committed
update README
1 parent 08531b0 commit 261f9e1

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.rst

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -164,23 +164,26 @@ You can also run them in parallel:
164164
Building Sphinx docs
165165
~~~~~~~~~~~~~~~~~~~~
166166

167-
Setup a Python environment with ``sphinx`` and ``sagemaker``:
167+
Setup a Python environment, and install the dependencies listed in ``doc/requirements.txt``:
168168

169169
::
170170

171+
# conda
171172
conda create -n sagemaker python=3.7
172173
conda activate sagemaker
173-
conda install sphinx==2.2.2
174-
pip install sagemaker --user
174+
conda install --file doc/requirements.txt
175175

176-
Install the Read The Docs theme:
176+
# pip
177+
pip install -r doc/requirements.txt
177178

178-
::
179179

180-
pip install sphinx_rtd_theme --user
180+
Clone/fork the repo, and install your local version:
181+
182+
::
181183

184+
pip install --upgrade .
182185

183-
Clone/fork the repo, ``cd`` into the ``sagemaker-python-sdk/doc`` directory and run:
186+
Then ``cd`` into the ``sagemaker-python-sdk/doc`` directory and run:
184187

185188
::
186189

0 commit comments

Comments
 (0)