# 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
from pathlib import Path

source_directory = Path('@SPHINX_SOURCE@')

# Add path to built module
sys.path.insert(0, os.path.abspath('@CMAKE_BINARY_DIR@'))

# Add _extensions
sys.path.insert(0, os.path.abspath(source_directory / ".." / "_extensions"))

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

project = "DepthAI API Docs"
copyright = u"@build_year@, Luxonis"
author = "Luxonis"
version = u"@DEPTHAI_PYTHON_VERSION@"
release = version
pypi_release = "2.0.0.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_tabs.tabs",
    "sphinx-prompt", 'sphinx_substitution_extensions', # Substitute certain variables inside code blocks
    "breathe", # Generate sphinx documentation from doxygen
    "sphinx.ext.autodoc", # Generate documentation from python module
    "sphinx.ext.napoleon",
    "autodocsumm",
    "sphinx.ext.viewcode",
    "sphinx.ext.intersphinx",
    "sphinx.ext.autosectionlabel",  # https://github.com/sphinx-doc/sphinx/issues/7697 wait for this and implement
    "sphinx_rtd_theme",
    "zephyr.warnings_filter",
    'sphinx.ext.mathjax',
]

# See https://github.com/sphinx-doc/sphinx/issues/7728
suppress_warnings = ['autosectionlabel.*']

# # Debug docstrings
# def autodoc_process_docstring(app, what, name, obj, options, lines):
#     print('process: ', what, name, obj, options, lines)
# def setup(app):
#     app.connect("autodoc-process-docstring", autodoc_process_docstring)

# substitutions
rst_prolog = '.. |release| replace:: ' + release

# Breathe Configuration
# Project name depthai-core -> path to doxygen generated by

# Check if we're running on Read the Docs' servers (set path to generate doxygen manually)
breathe_projects = {"depthai-core": "@DOXYGEN_OUTPUT_DIR@/xml"}
# Set depthai-core as default breathe project
breathe_default_project = "depthai-core"

# 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 zephyr.warnings_filter -----------------------------------
warnings_filter_config = str(source_directory / ".." / "known-warnings.txt")
warnings_filter_silent = False

# -- 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
}

# 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 = '_static/images/favicon.png'
html_css_files = [
    'css/index.css',
    'https://docs.luxonis.com/en/latest/_static/css/navbar.css',
]
html_js_files = [
    'https://docs.luxonis.com/en/latest/_static/js/navbar.js',
]
html_title = 'DepthAI documentation | Luxonis'

intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
