File tree 2 files changed +39
-5
lines changed 2 files changed +39
-5
lines changed Original file line number Diff line number Diff line change @@ -155,6 +155,43 @@ You can also run them in parallel:
155
155
tox -- -n auto tests/integ
156
156
157
157
158
+ Building Sphinx docs
159
+ ~~~~~~~~~~~~~~~~~~~~
160
+
161
+ Setup a Python environment with ``sphinx `` and ``sagemaker ``:
162
+
163
+ ::
164
+
165
+ conda create -n sagemaker python=3.7
166
+ conda activate sagemaker
167
+ conda install sphinx==2.2.2
168
+ pip install sagemaker --user
169
+
170
+ Install the Read The Docs theme:
171
+
172
+ ::
173
+
174
+ pip install sphinx_rtd_theme --user
175
+
176
+
177
+ Clone/fork the repo, ``cd `` into the ``sagemaker-python-sdk/doc `` directory and run:
178
+
179
+ ::
180
+
181
+ make html
182
+
183
+ You can edit the templates for any of the pages in the docs by editing the .rst files in the ``doc `` directory and then running ``make html `` again.
184
+
185
+ Preview the site with a Python web server:
186
+
187
+ ::
188
+
189
+ cd _build/html
190
+ python -m http.server 8000
191
+
192
+ View the website by visiting http://localhost:8000
193
+
194
+
158
195
MXNet SageMaker Estimators
159
196
--------------------------
160
197
Original file line number Diff line number Diff line change 13
13
"""Placeholder docstring"""
14
14
from __future__ import absolute_import
15
15
16
- import os
17
16
import pkg_resources
18
17
import sys
19
18
from datetime import datetime
@@ -83,10 +82,8 @@ def __getattr__(cls, name):
83
82
autodoc_default_flags = ["show-inheritance" , "members" , "undoc-members" ]
84
83
autodoc_member_order = "bysource"
85
84
86
- if "READTHEDOCS" in os .environ :
87
- html_theme = "default"
88
- else :
89
- html_theme = "haiku"
85
+ html_theme = "sphinx_rtd_theme"
86
+
90
87
html_static_path = []
91
88
htmlhelp_basename = "%sdoc" % project
92
89
You can’t perform that action at this time.
0 commit comments