# -*- coding: utf-8 -*-
# Licensed under a 3-clause BSD style license - see LICENSE.rst
#
# Astropy documentation build configuration file.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this file.
#
# All configuration values have a default. Some values are defined in
# the global Astropy configuration which is loaded here before anything else.
# See astropy.sphinx.conf for which values are set there.

# 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.
# sys.path.insert(0, os.path.abspath('..'))
# IMPORTANT: the above commented section was generated by sphinx-quickstart, but
# is *NOT* appropriate for astropy or Astropy affiliated packages. It is left
# commented out with this explanation to make it clear why this should not be
# done. If the sys.path entry above is added, when the astropy.sphinx.conf
# import occurs, it will import the *source* version of astropy instead of the
# version installed (if invoked as "make html" or directly with sphinx), or the
# version in the build directory (if "python setup.py build_sphinx" is used).
# Thus, any C-extensions that are needed to build the documentation will *not*
# be accessible, and the documentation will not build correctly.

import sys
import datetime
import sphinx

from specreduce import __version__

try:
    from sphinx_astropy.conf.v2 import *  # noqa
    from sphinx_astropy.conf.v2 import extensions  # noqa
except ImportError:
    print("ERROR: the documentation requires the sphinx-astropy package to be installed")
    sys.exit(1)

# xref: https://github.com/sphinx-doc/sphinx/issues/13232#issuecomment-2608708175
if sys.version_info[:2] >= (3, 13) and sphinx.version_info[:2] < (8, 2):
    import pathlib
    from sphinx.util.typing import _INVALID_BUILTIN_CLASSES

    _INVALID_BUILTIN_CLASSES[pathlib.Path] = "pathlib.Path"

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

# By default, highlight as Python 3.
highlight_language = "python3"

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

# To perform a Sphinx version check that needs to be more specific than
# major.minor, call `check_sphinx_version("x.y.z")` here.
# check_sphinx_version("1.2.1")

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns.append("_templates")

# This is added to the end of RST files - a good place to put substitutions to
# be used globally.
#rst_epilog += """
#.. _Astropy: https://www.astropy.org/
#"""

extensions.extend(
    [
        "sphinx_design",
        "nbsphinx",
    ]
)

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

# This does not *have* to match the package name, but typically does
project = "specreduce"
author = "Astropy Specreduce contributors"
copyright = "{0}, {1}".format(datetime.datetime.now().year, author)

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.

# The short X.Y version.
version = __version__.split("-", 1)[0]
# The full version, including alpha/beta/rc tags.
release = __version__


# -- Options for HTML output --------------------------------------------------

html_static_path = ["_static"]  # html_theme = None
html_style = "specreduce.css"

html_theme_options.update(
    {
        "github_url": "https://github.com/astropy/specreduce",
        "use_edit_page_button": False,
        "navigation_with_keys": False,
        "logo": {
            "text": f"{project}",
            "image_light": "_static/logo_icon.png",
            "image_dark": "_static/logo_icon.png",
        },
        "secondary_sidebar_items": {"**": ["page-toc"], "index": []},
    }
)

html_context = {
    "default_mode": "light",
    "version_slug": os.environ.get("READTHEDOCS_VERSION") or "",
    "to_be_indexed": ["stable", "latest"],
    "github_user": "astropy",
    "github_repo": "specreduce",
    "github_version": "main",
    "doc_path": "docs",
    "edit_page_url_template": "{{ astropy_custom_edit_url(github_user, github_repo, github_version, doc_path, file_name, default_edit_page_url_template) }}",
    "default_edit_page_url_template": "https://github.com/{github_user}/{github_repo}/edit/{github_version}/{doc_path}{file_name}",
    # Tell Jinja2 templates the build is running on Read the Docs
    "READTHEDOCS": os.environ.get("READTHEDOCS", "") == "True",
}

# Custom sidebar templates, maps document names to template names.
html_sidebars = {}
html_sidebars['index'] = []
html_sidebars["contributing"] = []

# html_sidebars['**'] = ['localtoc.html']
# html_sidebars['index'] = [] #['globaltoc.html', 'localtoc.html']

# The name of an image file (within the static path) to use as favicon of the
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
html_favicon = "_static/logo_icon.ico"

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
# html_last_updated_fmt = ''

# The name for this set of Sphinx documents.  If None, it defaults to
# "<project> v<release> documentation".
html_title = "{0} v{1}".format(project, release)

# Output file base name for HTML help builder.
htmlhelp_basename = project + "doc"

# Prefixes that are ignored for sorting the Python module index
modindex_common_prefix = ["specreduce."]

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

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [("index", project + ".tex", project + " Documentation", author, "manual")]


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

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [("index", project.lower(), project + " Documentation", [author], 1)]

# -- Options for numpydoc extension -------------------------------------------
numpydoc_xref_param_type = False


# -- Options for the edit_on_github extension ---------------------------------

# -- Turn on nitpicky mode for sphinx (to warn about references not found) ----
#
nitpicky = True
intersphinx_mapping.update(
    {
        "astropy": ("https://docs.astropy.org/en/stable/", None),
        "ccdproc": ("https://ccdproc.readthedocs.io/en/stable/", None),
        "specutils": ("https://specutils.readthedocs.io/en/stable/", None),
        "gwcs": ("https://gwcs.readthedocs.io/en/stable/", None),
    }
)
#
# Some warnings are impossible to suppress, and you can list specific references
# that should be ignored in a nitpick-exceptions file which should be inside
# the docs/ directory. The format of the file should be:
#
# <type> <class>
#
# for example:
#
# py:class astropy.io.votable.tree.Element
# py:class astropy.io.votable.tree.SimpleElement
# py:class astropy.io.votable.tree.SimpleElementWithContent
#
# Uncomment the following lines to enable the exceptions:
#
# for line in open('nitpick-exceptions'):
#     if line.strip() == "" or line.startswith("#"):
#         continue
#     dtype, target = line.split(None, 1)
#     target = target.strip()
#     nitpick_ignore.append((dtype, six.u(target)))

# -- Nitpick exceptions -------------------------------------------------------
# ArrayLike from numpy.typing is not properly resolved by intersphinx
nitpick_ignore = [
    ("py:class", "ArrayLike"),
    ("py:class", "numpy._typing.ArrayLike"),
]

# Ignore complex type annotations that can't be cross-referenced
# These come from autodoc processing dataclass fields with Literal, Union, and generic types
nitpick_ignore_regex = [
    (r"py:obj", r"typing\.Literal\[.*"),      # Literal types with string values
    (r"py:class", r"tuple\[.*"),               # Generic tuple types
    (r"py:class", r"None \| dict\[.*"),        # Union types with dict
    (r"py:class", r"dict\[.*"),                # Generic dict types
]

# -- Options for linkcheck output -------------------------------------------
linkcheck_retry = 5
linkcheck_ignore = [
    "https://www.aanda.org/",
]
linkcheck_timeout = 180
linkcheck_anchors = False
