# Copyright 2017-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from datetime import datetime import os import sys from pkg_resources import get_distribution sys.path.insert(0, os.path.abspath("..")) # -- Project information ----------------------------------------------------- project = "sagemaker-experiments" copyright = "%s, Amazon" % datetime.now().year author = "Amazon Web Services" version = get_distribution(project).version # -- 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 = [ "sphinx.ext.autodoc", "sphinx.ext.doctest", "sphinx.ext.intersphinx", "sphinx.ext.todo", "sphinx.ext.coverage", "sphinx.ext.autosummary", "sphinx.ext.napoleon", "sphinx.ext.autosectionlabel", ] # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] source_suffix = ".rst" # The suffix of source filenames. master_doc = "index" # The master toctree document. # The full version, including alpha/beta/rc tags. release = version # 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 = [] exclude_trees = ["_build"] pygments_style = "default" autoclass_content = "both" # autodoc_default_options = {"show-inheritance", "members", "undoc-members"} autodoc_member_order = "bysource" if "READTHEDOCS" in os.environ: html_theme = "default" else: html_theme = "haiku" html_static_path = [] htmlhelp_basename = "%sdoc" % project # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {"python": ("https://docs.python.org/3", None)} # autosummary autosummary_generate = True # autosectionlabel autosectionlabel_prefix_document = True