File tree Expand file tree Collapse file tree 3 files changed +12
-25
lines changed Expand file tree Collapse file tree 3 files changed +12
-25
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
Original file line number Diff line number Diff line change 1
- sphinx == 2.2.2
2
- numpy
3
- scipy
4
- requests == 2.20
1
+ sphinx == 3.1.1
2
+ sphinx-rtd-theme == 0.5.0
Original file line number Diff line number Diff line change @@ -98,20 +98,6 @@ commands =
98
98
[testenv:sphinx]
99
99
basepython = python3
100
100
changedir = doc
101
- # Based on: https://github.com/rtfd/readthedocs.org/blob/8f0c78dde5edcc85acf90462a8518735a25482d3/readthedocs/doc_builder/python_environments.py#L263
102
- install_command = python -m pip install --upgrade -I {packages}
103
- # Based on: https://github.com/rtfd/readthedocs.org/blob/8f0c78dde5edcc85acf90462a8518735a25482d3/readthedocs/doc_builder/python_environments.py#L280
104
- deps =
105
- Pygments ==2.2.0
106
- setuptools<40
107
- docutils ==0.13.1
108
- mock ==1.0.1
109
- alabaster>=0.7,<0.8,!=0.7.5
110
- commonmark ==0.5.4
111
- recommonmark ==0.4.0
112
- sphinx<1.8
113
- sphinx-rtd-theme<0.5
114
- readthedocs-sphinx-ext<0.6
115
101
# pip install requirements.txt is separate as RTD does it in separate steps
116
102
# having the requirements.txt installed in deps above results in Double Requirement exception
117
103
# https://github.com/pypa/pip/issues/988
You can’t perform that action at this time.
0 commit comments