# 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

CONF_PY_PATH = os.path.abspath(os.path.dirname(__file__))
PROJECT_ROOT_PATH = os.path.join(CONF_PY_PATH, "..", "src")
sys.path.insert(0, os.path.abspath(PROJECT_ROOT_PATH))

import template_project  # noqa: E402

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

project = "Template Project"
copyright = "2020, Enel S.p.A."
author = "Enel S.p.A."
version = template_project.__version__


# -- 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 = [
    "m2r2",
    "sphinx.ext.autodoc",
    "sphinx.ext.napoleon",
    "sphinx_autodoc_typehints",
    "sphinx.ext.autosummary",
    "sphinxcontrib.confluencebuilder",
]

# 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 = "sphinx_rtd_theme"

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

autosummary_generate = True
autosummary_imported_members = True

# -- Options to deploy on Confluence -----------------------------------------

confluence_publish = True
confluence_space_name = "DT"
confluence_server_url = "https://confluence.springlab.enel.com/"
confluence_server_user = os.getenv("AP_USER_NAME")
confluence_server_pass = os.getenv("AP_USER_SECRET")
confluence_parent_page = "Libraries"
confluence_page_hierarchy = True
confluence_purge = False
