conf.py

# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))


# -- Project information -----------------------------------------------------

project = "Amazon SageMaker Examples"
copyright = "2020, Amazon Web Services, Inc. or its affiliates. All rights reserved."
author = "Aaron Markham"

# The full version, including alpha/beta/rc tags
release = "1.0.0"


# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
    "nbsphinx", "IPython.sphinxext.ipython_console_highlighting"
]

# extension nbsphinx config
nbsphinx_execute = "never"


# Add any paths that contain templates here, relative to this directory.
# The _templates/layout.html override injects a note at the top of every page
# stating that this site holds only the SDK v3 example notebooks, and pointing at
# the v2 build for the archived SDK 2.x notebooks.
templates_path = ["_templates"]

# Serve robots.txt at the docs site root. ReadTheDocs serves robots.txt only from
# the default version, so it must live on this V3/default build (not the v2-archive
# build). It opts the deprecated V2 notebooks (/en/v2/) out of AI-training crawls.
# Sphinx copies files listed here verbatim into the build root.
html_extra_path = ["robots.txt"]

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
html_theme = "sphinx_rtd_theme"

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]

# For Adobe Analytics
html_js_files = [
    "https://a0.awsstatic.com/s_code/js/3.0/awshome_s_code.js",
    "https://d2c.aws.amazon.com/client/loader/v1/d2c-load.js",
]

html_css_files = [
    'pagination.css',
    'search_accessories.css',
]