Skip to content

Commit 69c45ce

Browse files
authored
Treat warnings as errors when building documentation. (#631)
1 parent 3d1690d commit 69c45ce

File tree

6 files changed

+22
-19
lines changed

6 files changed

+22
-19
lines changed

.readthedocs.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# ReadTheDocs environment customization to allow us to use conda to install
2+
# libraries which have C dependencies for the doc build. See:
3+
# https://docs.readthedocs.io/en/latest/config-file/v2.html
4+
5+
version: 2
6+
7+
python:
8+
version: 3.6
9+
install:
10+
- method: pip
11+
path: .
12+
- requirements: doc/requirements.txt
13+
14+
sphinx:
15+
configuration: doc/conf.py
16+
fail_on_warning: true # http://www.sphinx-doc.org/en/master/man/sphinx-build.html#id6

.rtd-environment.yml

Lines changed: 0 additions & 9 deletions
This file was deleted.

doc/requirements.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
sphinx==1.7.9
2+
numpy
3+
scipy
4+
requests==2.20

doc/using_mxnet.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -357,6 +357,7 @@ The following are optional arguments. When you create an ``MXNet`` object, you c
357357
results in the following inside the container:
358358

359359
.. code::
360+
360361
opt/ml/code
361362
├── train.py
362363
├── common

readthedocs.yml

Lines changed: 0 additions & 9 deletions
This file was deleted.

src/sagemaker/tuner.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -490,7 +490,7 @@ def hyperparameter_ranges(self):
490490

491491
@property
492492
def sagemaker_session(self):
493-
"""Convenience method for accessing the :class:~`sagemaker.session.Session` object associated
493+
"""Convenience method for accessing the :class:`~sagemaker.session.Session` object associated
494494
with the estimator for the ``HyperparameterTuner``.
495495
"""
496496
return self.estimator.sagemaker_session

0 commit comments

Comments
 (0)