conf.py

# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/stable/config

# -- 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('.'))

import os, codecs

# -*- coding: utf-8 -*-
#
# AWS Sphinx configuration file.
#

#
# General information about the project.
#

# The long version of the service or SDK name, such as "Amazon Simple Workflow
# Service", "AWS Flow Framework for Ruby" or "AWS SDK for Java"
service_name_long = u'AWS Cloud Development Kit'
service_docs_home = u'https://awslabs.github.io/aws-cdk'

project = u'AWS Cloud Development Kit'
project_desc = u'The AWS CDK is a software development framework for defining cloud infrastructure components in code'
project_basename = u'CDK/ug'

# This name is used as the manual / PDF name. Don't include the extension
# (.pdf) here.
man_name = u'cdk-ug'

# Optional forum ID. If there's a relevant forum at forums.aws.amazon.com, then
# set the ID here. If not set, then no forum ID link will be generated.
forum_id = u'0'

# For the url docs.aws.amazon.com/docset-root/version/guide-name
docset_path_slug = u'CDK'
version_path_slug = u'latest'
guide_path_slug = u'ug'

build_html = True
build_pdf = True
build_mobi = False #Or the Kindle ASIN if you need a Kindle build

feedback_folder_id = u'ceb51e73-f57c-4911-8bb5-f95408af889a'

extra_navlinks = []

# EXTRA_CONF_CONTENT -- don't change, move or remove this line!


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

copyright = u'2018, Amazon Web Services'
author = u'Amazon Web Services'

# CDK_VERSION automatically replaced by build script
version = os.environ['CDK_VERSION']
release = version

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

# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'

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

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = ['.rst', '.md']

# The master toctree document.
master_doc = 'index'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None

# 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 = [
    '**/_*.md'
]

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'


# -- 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"
html_title = service_name_long

# Theme options are theme-specific and customize the look and feel of a theme
# further.  For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}

# 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']

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself.  Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
html_sidebars = {
    '**': [ 'globaltoc.html', 'searchbox.html' ]
}

rst_epilog = '\n'

common_includes = [
    '_includes/common_includes.txt',
    '_includes.txt'
]

for i in common_includes:
    if os.path.exists(i):
        f = codecs.open(i, 'r', 'utf-8')
        rst_epilog += f.read()
        f.close()

rst_epilog += '\n.. |cdk-version| replace:: ' + version + '\n'

# -- Options for HTMLHelp output ---------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'AWSCloudDevelopmentKitdoc'

show_sphinx = False

# -- Options for LaTeX output ------------------------------------------------

latex_elements = {
    # The paper size ('letterpaper' or 'a4paper').
    #
    # 'papersize': 'letterpaper',

    # The font size ('10pt', '11pt' or '12pt').
    #
    # 'pointsize': '10pt',

    # Additional stuff for the LaTeX preamble.
    #
    # 'preamble': '',

    # Latex figure (float) alignment
    #
    # 'figure_align': 'htbp',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
#  author, documentclass [howto, manual, or own class]).
latex_documents = [
    (master_doc, 'AWSCloudDevelopmentKit.tex', u'AWS Cloud Development Kit Documentation',
     u'Amazon Web Service', 'manual'),
]


# -- Options for manual page output ------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    (master_doc, 'awsclouddevelopmentkit', u'AWS Cloud Development Kit Documentation',
     [author], 1)
]


# -- Options for Texinfo output ----------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
#  dir menu entry, description, category)
texinfo_documents = [
    (master_doc, 'AWSCloudDevelopmentKit', u'AWS Cloud Development Kit Documentation',
     author, 'AWSCloudDevelopmentKit', 'One line description of project.',
     'Miscellaneous'),
]