feature: add adobe analytics script; upgrade sphinx to support custom js

Author: aaronmarkham

README.rst

@@ -155,6 +155,43 @@ You can also run them in parallel:
     tox -- -n auto tests/integ
 
 
+Building Sphinx docs
+~~~~~~~~~~~~~~~~~~~~
+
+Setup a Python environment with ``sphinx`` and ``sagemaker``:
+
+::
+
+    conda create -n sagemaker python=3.7
+    conda activate sagemaker
+    conda install sphinx==2.2.2
+    pip install sagemaker --user
+
+Install the Read The Docs theme:
+
+::
+
+    pip install sphinx_rtd_theme --user
+
+
+Clone/fork the repo, ``cd`` into the ``sagemaker-python-sdk/doc`` directory and run:
+
+::
+
+    make html
+
+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.
+
+Preview the site with a Python web server:
+
+::
+
+    cd _build/html
+    python -m http.server 8000
+
+View the website by visiting http://localhost:8000
+
+
 MXNet SageMaker Estimators
 --------------------------
 

doc/_static/js/analytics.js

@@ -0,0 +1,2 @@
+console.log("Starting analytics...");
+var s_code=s.t();if(s_code)document.write(s_code)

doc/conf.py

@@ -13,7 +13,6 @@
 """Placeholder docstring"""
 from __future__ import absolute_import
 
-import os
 import pkg_resources
 import sys
 from datetime import datetime
@@ -83,13 +82,13 @@ def __getattr__(cls, name):
 autodoc_default_flags = ["show-inheritance", "members", "undoc-members"]
 autodoc_member_order = "bysource"
 
-if "READTHEDOCS" in os.environ:
-    html_theme = "default"
-else:
-    html_theme = "haiku"
-html_static_path = []
+html_theme = "sphinx_rtd_theme"
+
+html_static_path = ["_static"]
 htmlhelp_basename = "%sdoc" % project
 
+html_js_files = ["https://a0.awsstatic.com/s_code/js/1.0/awshome_s_code.js", "js/analytics.js"]
+
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {"http://docs.python.org/": None}
 

doc/requirements.txt

@@ -1,4 +1,4 @@
-sphinx==1.7.9
+sphinx==2.2.2
 numpy
 scipy
-requests==2.20
+requests==2.20