File tree 1 file changed +10
-7
lines changed
1 file changed +10
-7
lines changed Original file line number Diff line number Diff line change @@ -164,23 +164,26 @@ You can also run them in parallel:
164
164
Building Sphinx docs
165
165
~~~~~~~~~~~~~~~~~~~~
166
166
167
- Setup a Python environment with `` sphinx `` and `` sagemaker ``:
167
+ Setup a Python environment, and install the dependencies listed in `` doc/requirements.txt ``:
168
168
169
169
::
170
170
171
+ # conda
171
172
conda create -n sagemaker python=3.7
172
173
conda activate sagemaker
173
- conda install sphinx==2.2.2
174
- pip install sagemaker --user
174
+ conda install --file doc/requirements.txt
175
175
176
- Install the Read The Docs theme:
176
+ # pip
177
+ pip install -r doc/requirements.txt
177
178
178
- ::
179
179
180
- pip install sphinx_rtd_theme --user
180
+ Clone/fork the repo, and install your local version:
181
+
182
+ ::
181
183
184
+ pip install --upgrade .
182
185
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:
184
187
185
188
::
186
189
You can’t perform that action at this time.
0 commit comments