"""Nilearn documentation build configuration file.

created by sphinx-quickstart on Fri Jan  8 09:13:42 2010.

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
autogenerated file.

All configuration values have a default;
values that are commented out serve to show the default.
"""

import os
import re
import sys
from pathlib import Path

from nilearn._version import __version__
from sphinx.domains import changeset
from sphinx.locale import _

# ----------------------------------------------------------------------------


# 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, str(Path("sphinxext").absolute()))

# See https://www.sphinx-doc.org/en/master/usage/extensions/linkcode.html
from github_link import make_linkcode_resolve

linkcode_resolve = make_linkcode_resolve

# We also add the directory just above to enable local imports of nilearn
sys.path.insert(0, str(Path("..").absolute()))

# -- Plotly Configuration ----------------------------------------------------

try:
    import plotly.io as pio

    pio.renderers.default = "sphinx_gallery"
except ImportError:
    import warnings

    warnings.warn(
        stacklevel=2,
        message="Plotly is not installed. Plotly figures will not be shown.",
        category=UserWarning,
    )

# -- 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 = [
    "gh_substitutions",
    "myst_parser",
    "numpydoc",
    "sphinx_copybutton",
    "sphinx_design",
    "sphinx_gallery.gen_gallery",
    "sphinx.ext.autodoc",
    "sphinx.ext.autosummary",
    "sphinx.ext.extlinks",
    "sphinx.ext.imgmath",
    "sphinx.ext.intersphinx",
    "sphinx.ext.linkcode",
    "sphinxcontrib.bibtex",
    "sphinxcontrib.mermaid",
    "sphinxext.opengraph",
]

autosummary_generate = True

autodoc_typehints = "none"

autodoc_default_options = {
    "imported-members": True,
    "inherited-members": True,
    "undoc-members": True,
    "member-order": "bysource",
}

# Get rid of spurious warnings due to some interaction between
# autosummary and numpydoc. See
# https://github.com/phn/pytpm/issues/3#issuecomment-12133978 for more
# details
numpydoc_show_class_members = False
# Add any paths that contain templates here, relative to this directory.
templates_path = ["templates"]

# generate autosummary even if no references
autosummary_generate = True

# The suffix of source filenames.
source_suffix = {".rst": "restructuredtext", ".md": "markdown"}

# The encoding of source files.
# source_encoding = 'utf-8'

# Generate the plots for the gallery
plot_gallery = "True"

# The master toctree document.
master_doc = "index"

# sphinxcontrib-bibtex
bibtex_bibfiles = ["./references.bib", "./soft_references.bib"]
bibtex_style = "unsrt"
bibtex_reference_style = "author_year"
bibtex_footbibliography_header = ""

# General information about the project.
project = "Nilearn"

copyright = """The nilearn developers
- Code and documentation distributed under BSD license."""


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

# Latest release version
try:
    latest_release = re.match(
        r"v?([0-9]+.[0-9]+.[0-9]+).*",
        os.popen("git describe --tags").read().strip(),
    ).groups()[0]
except AttributeError:
    # This may fail in case the git tags were not fetched.
    # So let's have a back up.
    latest_release = "0.11.0"

# The full current version, including alpha/beta/rc tags.
current_version = __version__

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
language = "en"

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
# today = ''
# Else, today_fmt is used as the format for a strftime call.
# today_fmt = '%B %d, %Y'

# List of documents that shouldn't be included in the build.
# unused_docs = []
exclude_patterns = [
    "tune_toc.rst",
    "includes/big_toc_css.rst",
    "includes/bigger_toc_css.rst",
]

# List of directories, relative to source directory, that shouldn't be
# searched for source files.
exclude_trees = ["_build", "templates", "includes"]

# The reST default role (used for this markup: `text`) to use for all
# documents.
# default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = False

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
# add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
# show_authors = False

# The name of the Pygments (syntax highlighting) style to use.
# https://pygments.org/styles/
pygments_style = "sas"
pygments_dark_style = "monokai"

# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []

# A list of warning types to suppress arbitrary warning messages
suppress_warnings = ["image.not_readable", "config.cache"]

linkcheck_allowed_redirects = {
    "https://balsa.wustl.edu": r"https://balsa.wustl.eduapp/template/.*",
    r"http://humanconnectome.org/.*": r"https://store.humanconnectome.org/.*",
    # Issue redirect to PR
    r"https://github.com/nilearn/nilearn/issues/.*": r"https://github.com/nilearn/nilearn/pull/.*",
    # OSF downloads
    r"https://osf.io/.*/download": r"https://files.osf.io/.*",
    # doi redirect
    "https://doi.org/": r"https://.*",
}

linkcheck_ignore = [
    # ignore nilearn github issues mostly for the sake of speed
    # given that there many of those in our changelog
    r"https://github.com/nilearn/nilearn/issues.*",
    # those are needed because figures
    # cannot take sphinx gallery reference as target
    r"../auto_examples/.*html",
    r"auto_examples/.*html",
    "https://github.com/nilearn/nilearn/issues/new/choose",
    (
        "https://www.info.gouv.fr/"
        "organisation/"  # codespell:ignore organisation
        "secretariat-general-pour-l-investissement-sgpi"
    ),
    # give a 403 Client Error: Forbidden for url:
    r"https://sites.wustl.edu/oasisbrains/.*",
    # similarly below are publishers that do not like doi redirects:
    r"https://doi.org/.*",
    # do not check download links for OSF
    r"https://osf.io/.*/download",
    # neurovault and some of our datasets websites can be flaky
    r"https://neurovault.org.*",
    r"https://fsl.fmrib.ox.ac.uk/fsl/docs.*",
    r"https://fcon_1000.projects.nitrc.org.*",
    r"https://pkgs.org/search.*",
    r"https://pmc.ncbi.nlm.nih.gov/articles.*",
    r"https://pubmed.ncbi.nlm.nih.gov.*",
    r"https://rrid.site/data/record.*",
    r"https://sites.wustl.edu/oasisbrains.*",
    r"https://www.cambridge.org/be/universitypress.*",
    r"../../_static/notebook_reports_.*",
    "http://brainomics.cea.fr/localizer/",
    "https://childmind.org/science/global-open-science/healthy-brain-network/",
    "https://digicosme.cnrs.fr/en/digicosme-paris-saclay-english/",
    "https://figshare.com/articles/dataset/Group_multiscale_functional_template_generated_with_BASC_on_the_Cambridge_sample/1285615",
    "https://imaging.mrc-cbu.cam.ac.uk/imaging/DesignEfficiency",
    "https://octave.org",
    "https://pages.saclay.inria.fr/bertrand.thirion/",
    "https://pages.stern.nyu.edu/~wgreene/Text/econometricanalysis.htm",
    "https://surfer.nmr.mgh.harvard.edu/",
    "https://www.gin.cnrs.fr/en/tools/aal",
]

linkcheck_exclude_documents = [r".*/sg_execution_times.rst"]

linkcheck_allow_unauthorized = True

linkcheck_report_timeouts_as_broken = False

# double default rate_limit_timeout
linkcheck_rate_limit_timeout = 600.0

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

# The theme to use for HTML and HTML Help pages.  Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
html_theme = "furo"

# Add custom css instructions from themes/custom.css
font_awesome = "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.2/css/"
html_css_files = [
    "custom.css",
    f"{font_awesome}all.min.css",
    f"{font_awesome}fontawesome.min.css",
    f"{font_awesome}solid.min.css",
    f"{font_awesome}brands.min.css",
]

# The style sheet to use for HTML and HTML Help pages. A file of that name
# must exist either in Sphinx' static/ path, or in one of the custom paths
# given in html_static_path.
# html_style = 'nature.css'

# 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 = {
    "dark_css_variables": {
        "color-announcement-background": "#935610",
        "color-announcement-text": "#FFFFFF",
    },
    "light_css_variables": {
        "admonition-font-size": "100%",
        "admonition-title-font-size": "100%",
        "color-announcement-background": "#FBB360",
        "color-announcement-text": "#111418",
        "color-admonition-title--note": "#448aff",
        "color-admonition-title-background--note": "#448aff10",
    },
    "source_repository": "https://github.com/nilearn/nilearn/",
    "source_branch": "main",
    "source_directory": "doc/",
    "footer_icons": [
        {
            "name": "GitHub",
            "url": "https://github.com/nilearn/nilearn",
            "html": "",
            "class": "fa-brands fa-solid fa-github fa-2x",
        },
        {
            "name": "Bluesky",
            "url": "https://bsky.app/profile/nilearn.bsky.social",
            "html": "",
            "class": "fa-brands fa-solid fa-bluesky fa-2x",
        },
        {
            "name": "Mastodon",
            "url": "https://fosstodon.org/@nilearn",
            "html": "",
            "class": "fa-brands fa-solid fa-mastodon fa-2x",
        },
        {
            "name": "Discord",
            "url": "https://discord.com/invite/SsQABEJHkZ",
            "html": "",
            "class": "fa-brands fa-solid fa-discord fa-2x",
        },
        {
            "name": "Youtube",
            "url": "https://www.youtube.com/channel/UCU6BMAi2zOhNFnDkbdevmPw",
            "html": "",
            "class": "fa-brands fa-solid fa-youtube fa-2x",
        },
    ],
}

# Add banner in case version is not stable
if "dev" in current_version:
    html_theme_options["announcement"] = (
        "<p>This is the development documentation "
        f"of nilearn ({current_version}) "
        '<a class="sd-sphinx-override sd-badge sd-text-wrap '
        'sd-btn-outline-dark reference external" '
        'href="https://nilearn.github.io">'
        f"<span>Switch to stable version ({latest_release})</span></a></p>"
    )

# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = ['themes']

# The name for this set of Sphinx documents.  If None, it defaults to
# "<project> v<release> documentation".
html_title = "Nilearn"

# A shorter title for the navigation bar.  Default is the same as html_title.
html_short_title = "Nilearn"

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = "logos/nilearn-transparent.png"

# 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 = "logos/favicon.ico"

# 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 = ["images", "themes", "reports"]

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

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
# html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
# html_additional_pages = {}

# If false, no module index is generated.
html_use_modindex = False

# If false, no index is generated.
html_use_index = False

# If true, the index is split into individual pages for each letter.
# html_split_index = False

# If true, links to the reST sources are added to the pages.
html_show_sourcelink = False

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it.  The value of this option must be the
# base URL from which the finished HTML is served.
# html_use_opensearch = ''

# variables to pass to HTML templating engine
build_dev_html = bool(int(os.environ.get("BUILD_DEV_HTML", False)))

html_context = {"build_dev_html": build_dev_html}

# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
# html_file_suffix = ''

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

# Sphinx copybutton config
copybutton_prompt_text = ">>> "

trim_doctests_flags = True

_python_doc_base = "https://docs.python.org/3.10"

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
    "python": (_python_doc_base, None),
    "numpy": ("https://numpy.org/doc/stable/", None),
    "scipy": ("https://scipy.github.io/devdocs/", None),
    "matplotlib": ("https://matplotlib.org/stable/", None),
    "sklearn": ("https://scikit-learn.org/stable/", None),
    "nibabel": ("https://nipy.org/nibabel", None),
    "pandas": ("https://pandas.pydata.org/pandas-docs/stable/", None),
    "nistats": ("https://nistats.github.io", None),
    "joblib": ("https://joblib.readthedocs.io/en/latest/", None),
    "plotly": ("https://plotly.com/python-api-reference/", None),
}

extlinks = {
    "sklearn": ("https://scikit-learn.org/stable/%s", None),
    "inria": ("https://team.inria.fr/%s", None),
    "nilearn-gh": ("https://github.com/nilearn/nilearn/%s", None),
    "neurostars": ("https://neurostars.org/tag/nilearn/%s", None),
    "nipy": ("https://nipy.org/%s", None),
}

# Check intersphinx reference targets exist
nitpicky = True
# Temporary solution to nilearn/nilearn#3997
nitpick_ignore = [
    ("py:class", "sklearn.utils.metadata_routing.MetadataRequest"),
]

binder_branch = "main" if "dev" in current_version else current_version

sphinx_gallery_conf = {
    "doc_module": "nilearn",
    "backreferences_dir": Path("modules", "generated"),
    "reference_url": {"nilearn": None},
    "junit": "../test-results/sphinx-gallery/junit.xml",
    "examples_dirs": "../examples/",
    "gallery_dirs": "auto_examples",
    # Ignore the function signature leftover by joblib
    "ignore_pattern": r"func_code\.py",
    "show_memory": not sys.platform.startswith("win"),
    "remove_config_comments": True,
    "nested_sections": True,
    "binder": {
        "org": "nilearn",
        "repo": "nilearn",
        "binderhub_url": "https://mybinder.org",
        "branch": binder_branch,
        "dependencies": "./binder/requirements.txt",
        "use_jupyter_lab": True,
    },
    "default_thumb_file": "logos/nilearn-desaturate-100.png",
    "within_subsection_order": "ExampleTitleSortKey",
}

mermaid_version = "11.4.0"


def touch_example_backreferences(
    app,
    what,  # noqa: ARG001
    name,
    obj,  # noqa: ARG001
    options,  # noqa: ARG001
    lines,  # noqa: ARG001
):
    # generate empty examples files, so that we don't get
    # inclusion errors if there are no examples for a class / module
    examples_path = Path(
        app.srcdir, "modules", "generated", f"{name}.examples"
    )
    if not examples_path.exists():
        examples_path.touch()


# adapting https://github.com/sphinx-doc/sphinx/blob/master/sphinx/domains/changeset.py
changeset.versionlabels["nilearn_versionadded"] = _("Added in Nilearn %s")
changeset.versionlabels["nilearn_versionchanged"] = _("Changed in Nilearn %s")
changeset.versionlabels["nilearn_deprecated"] = _(
    "Deprecated since Nilearn %s"
)
changeset.versionlabels["nilearn_versionremoved"] = _("Removed in Nilearn %s")
changeset.versionlabel_classes["nilearn_versionadded"] = "added"
changeset.versionlabel_classes["nilearn_versionchanged"] = "changed"
changeset.versionlabel_classes["nilearn_deprecated"] = "deprecated"
changeset.versionlabel_classes["nilearn_versionremoved"] = "removed"


def setup(app):
    app.add_directive("nilearn_versionadded", changeset.VersionChange)
    app.add_directive("nilearn_versionchanged", changeset.VersionChange)
    app.add_directive("nilearn_deprecated", changeset.VersionChange)
    app.add_directive("nilearn_versionremoved", changeset.VersionChange)

    app.connect("autodoc-process-docstring", touch_example_backreferences)


# -- sphinxext.opengraph configuration -------------------------------------
ogp_site_url = "https://nilearn.github.io/"
ogp_image = "https://nilearn.github.io/_static/nilearn-logo.png"
ogp_use_first_image = True
ogp_site_name = "Nilearn"
