# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/master/config

# -- 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.
# sys.path.insert(0, os.path.abspath('.'))

# Standard Library
import os
import sys

# Get configuration information from toml
import tomllib
import datetime

with open("../Cargo.toml", "rb") as config:
    cargotoml = tomllib.load(config)

sys.path.insert(0, os.path.abspath(".."))

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

project = cargotoml["package"]["name"]
author = " ".join(cargotoml["package"]["authors"])
copyright = f"{datetime.datetime.now().year}, {author}"


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


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

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

extensions = [
    "sphinx.ext.autodoc",
    "sphinx.ext.doctest",
    "sphinx.ext.intersphinx",
    # to allow usage of a folder not in docs
    "sphinxcontrib.collections",
    "sphinx.ext.githubpages",
    "sphinx.ext.autosummary",
    # Extension for plotting image in the doc
    "matplotlib.sphinxext.plot_directive",
    # To support Numpy docstrings, we use this extension:
    # see https://numpydoc.readthedocs.io/en/latest/install.html
    "numpydoc",
    "sphinxcontrib.bibtex",
    "sphinx.ext.mathjax",
    # for notebooks
    "nbsphinx",
    # to add copypaste of notebook cells
    "sphinx_copybutton",
    "sphinx_gallery.load_style",
]
default_role = "py:obj"
numpydoc_class_members_toctree = False
numpydoc_show_class_members = False
autosummary_generate = False
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
bibtex_bibfiles = ["references.bib"]

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = ".rst"

# The master toctree document.
master_doc = "index"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = "en"

# 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", "**.ipynb_checkpoints"]

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "sphinx"


# -- 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 = "bootstrap-astropy"

# Theme options are theme-specific and customize the look and feel of a theme
# further.  For a list of options available for each theme, see the
# documentation.
#
html_theme_options = {
    "logotext1": "cds",  # white,  semi-bold
    "logotext2": "healpix",  # orange, light
    "logotext3": ":docs",  # white,  light
    "astropy_project_menubar": 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"]

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself.  Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
# html_sidebars = {}

# -- Add the notebooks to Sphinx root folder with collections ----------------

collections = {
    "notebooks": {
        "driver": "copy_folder",
        "source": "../notebooks/",
        "target": "notebooks",
        "ignore": [".fits", ".ipynb_checkpoints/*"],
    }
}

# -- Configuration for nbsphinx ----------------------------------------------

nbsphinx_allow_errors = True


# -- Options for HTMLHelp output ---------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = "cdshealpixdoc"


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

latex_elements = {
    # The paper size ('letterpaper' or 'a4paper').
    #
    # 'papersize': 'letterpaper',
    # The font size ('10pt', '11pt' or '12pt').
    #
    # 'pointsize': '10pt',
    # Additional stuff for the LaTeX preamble.
    #
    # 'preamble': '',
    # Latex figure (float) alignment
    #
    # 'figure_align': 'htbp',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
#  author, documentclass [howto, manual, or own class]).
title = "cdshealpix Documentation"
latex_documents = [
    (
        master_doc,
        "cdshealpix.tex",
        title,
        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 = [(master_doc, "cdshealpix", title, author, 1)]


# -- Options for Texinfo output ----------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
#  dir menu entry, description, category)
texinfo_documents = [
    (
        master_doc,
        project,
        title,
        author,
        project,
        cargotoml["package"]["description"],
        cargotoml["package"]["categories"],
    ),
]


# -- Options for Epub output -------------------------------------------------

# Bibliographic Dublin Core info.
epub_title = project

# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#
# epub_identifier = ''

# A unique identification for the text.
#
# epub_uid = ''

# A list of files that should not be packed into the epub file.
epub_exclude_files = ["search.html"]


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

# -- Options for intersphinx extension ---------------------------------------

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
    "python": ("https://docs.python.org/3/", None),
    "astropy": ("https://docs.astropy.org/en/latest/", None),
    "numpy": ("https://numpy.org/doc/stable/", None),
    "matplotlib": ("https://matplotlib.org/stable/", None),
}


def setup(app):
    """Set the app up."""
    pass
