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

# so autodoc can import the app
import os
import sys

sys.path.append(os.path.abspath('..'))


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

project = 'Falcon-Caching'
copyright = '2019, Zoltan Fedor'
author = 'Zoltan Fedor'

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


# -- 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.coverage',
    'sphinx.ext.napoleon'
]

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

# 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 = 'alabaster'

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


# -- Extension configuration -------------------------------------------------


# Napoleon settings:
# see https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html?highlight=sphinx#configuration
napoleon_google_docstring = True
napoleon_numpy_docstring = False

# allow adding custom templates from the _templates/ directory
html_sidebars = {
    '**': ['globaltoc.html', 'relations.html', 'searchbox.html']
}

# to ensure the read-the-docs will find it,
# see https://github.com/readthedocs/readthedocs.org/issues/2569
master_doc = 'index'

# Custom sidebar templates, maps document names to template names.
#
# Custom sidebar templates, maps document names to template names.
html_sidebars = {
    '**': [
        'about.html',
        'localtoc.html',
        'sidebarlinks.html',
        'relations.html',
        'searchbox.html',
    ]
}
