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

import sphinx_rtd_theme

import lightly

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

project = "lightly"
copyright_year = "2020"
copyright = "Lightly AG"
website_url = "https://www.lightly.ai/"
author = "Philipp Wirth, Igor Susmelj"

# The full version, including alpha/beta/rc tags
release = lightly.__version__
master_doc = "index"


# -- 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.napoleon",
    "sphinx_rtd_theme",
    "sphinx.ext.autosummary",
    "sphinx_gallery.gen_gallery",
    "sphinx_tabs.tabs",
    "sphinx_copybutton",
    "sphinx_design",
    "sphinx_reredirects",
]

sphinx_gallery_conf = {
    "examples_dirs": ["tutorials_source/package", "tutorials_source/platform"],
    "gallery_dirs": [
        "tutorials/package",
        "tutorials/platform",
    ],  # path to where to save gallery generated output
    "filename_pattern": "/tutorial_",
}

napoleon_google_docstring = True
napoleon_numpy_docstring = False
napoleon_include_init_with_doc = False
napoleon_include_private_with_doc = False
napoleon_include_special_with_doc = False
napoleon_use_admonition_for_examples = False
napoleon_use_admonition_for_notes = False
napoleon_use_admonition_for_references = False
napoleon_use_ivar = False
napoleon_use_param = False
napoleon_use_rtype = False
napoleon_type_aliases = None

# 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 = []


# -- 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_theme_options = {
    "collapse_navigation": False,  # set to false to prevent menu item collapse
    "logo_only": True,
}

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

html_favicon = "favicon.png"

html_logo = "../logos/lightly_logo_crop_white_text.png"

# Exposes variables so that they can be used by django
html_context = {
    "copyright_year": copyright_year,
    "website_url": website_url,
}
