conf.py

# Copyright 2019 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://www.apache.org/licenses/LICENSE-2.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 __future__ import absolute_import

import os
import pkg_resources
import sys
from datetime import datetime
from unittest.mock import MagicMock

class Mock(MagicMock):
    @classmethod
    def __getattr__(cls, name):
        """
        Args:
            name:
        """
        if name == "__version__":
            return "1.4.0"
        else:
            return MagicMock()


MOCK_MODULES = [
    'boto3',
    'sagemaker',
    'sagemaker.model',
    'sagemaker.model_monitor',
    'sagemaker.pipeline',
    'sagemaker.sklearn',
    'sagemaker.sklearn.estimator',
    'sagemaker.utils',
    'sagemaker.workflow',
    'sagemaker.workflow.airflow',
    'IPython',
    'IPython.core',
    'IPython.core.display'
]

sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)

project = u"stepfunctions"
version = pkg_resources.require(project)[0].version

# 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.autosummary",
    "sphinx.ext.intersphinx",
    "sphinx.ext.todo",
    "sphinx.ext.coverage",
    "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.

copyright = u"%s, Amazon" % datetime.now().year

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

# List of directories, relative to source directory, that shouldn't be searched
# for source files.
exclude_trees = ["_build"]

pygments_style = "default"

autoclass_content = "both"
autodoc_default_flags = ["show-inheritance", "members", "no-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

intersphinx_mapping = {
    "https://docs.python.org/3.6/": None,
    "https://boto3.readthedocs.io/en/latest": None,
    "https://sagemaker.readthedocs.io/en/stable": None,
}

# autosummary
autosummary_generate = True

# autosectionlabel
autosectionlabel_prefix_document = True