# -*- coding: utf-8 -*-
#
# ECCO Version 4 Python Tutorial documentation build configuration file, created by
# sphinx-quickstart on Sat Jan 27 21:06:17 2018.
#
# 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.

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

# # mock modules (so that ecco_access can be imported, 
# # even though sphinx can not access these dependencies)
# class Mock(object):
#     def __init__(self, *args, **kwargs):
#         pass
# 
#     def __call__(self, *args, **kwargs):
#         return Mock()
# 
#     @classmethod
#     def __getattr__(cls, name):
#         if name in ('__file__', '__path__'):
#             return '/dev/null'
#         elif name[0] == name[0].upper():
#             return type(name, (), {})
#         else:
#             return Mock()
# 
# MOCK_MODULES = ['requests','zarr','numpy','xarray','pandas','tqdm','s3fs','fsspec']
# for mod_name in MOCK_MODULES:
#     sys.modules[mod_name] = Mock()
# 
# import ecco_access as ea

import subprocess

#import cloud_sptheme as csp
import sphinx_rtd_theme


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

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

# 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.ext.autodoc',
    'sphinx.ext.doctest',
    'sphinx.ext.todo',
    'sphinx.ext.coverage',
    'sphinx.ext.imgmath',
    'sphinx.ext.ifconfig',
    'sphinx.ext.viewcode',
    'sphinx.ext.autosummary',
    'sphinx.ext.extlinks',
    'sphinx.ext.napoleon',
    'nbsphinx',
    'myst_parser'
]
# Napoleon settings
napoleon_google_docstring = True
napoleon_numpy_docstring = True
napoleon_include_init_with_doc = False
napoleon_include_private_with_doc = False
napoleon_include_special_with_doc = True
napoleon_use_admonition_for_examples = False
napoleon_use_admonition_for_notes = False
napoleon_use_admonition_for_references = False
napoleon_use_ivar = False
napoleon_use_param = True
napoleon_use_rtype = True

#    'cloud_sptheme.ext.autodoc_sections',
#    'cloud_sptheme.ext.autoattribute_search_bases']
# From xmitgcm's conf.py
autosummary_generate = True
numpydoc_class_members_toctree = True
numpydoc_show_class_members = False

#html_math_renderer = 'imgmath'
#imgmath_image_format = 'svg'
#imgmath_font_size = 14

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

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

# General information about the project.
project = u'ecco_access'
copyright = u'2025, Andrew Delman'
author = u'Andrew Delman, Ian Fenty, and other contributors'

html_show_sourcelink = True
srclink_project = "https://github.com/ECCO-GROUP/ECCO-ACCESS"
srclink_branch = "main"
srclink_src_path = "doc/"

# 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 full version, including alpha/beta/rc tags
# Get release/version info from latest git tag
release_tag = subprocess.run(
                 ['git','describe','--tags','--always'],
                 capture_output=True,text=True,check=True).stdout.strip()
release = release_tag[1:].split("-")[0]
# The short X.Y version.
version = ".".join(release.split(".")[:2])

# 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 patterns also effect to 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'

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True


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

# 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 = {
    "repository_url": "https://github.com/ECCO-GROUP/ECCO-ACCESS",
    "repository_branch": "main",
    "path_to_docs": "doc",
    "use_repository_button": True,
}

html_title = f"{project} documentation: version {version}"

# 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_extra_path = ['api_extra']


# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# This is required for the alabaster theme
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
#html_sidebars = {
#    '**': [
#        'about.html',
#        'navigation.html',
#        'relations.html',  # needs 'show_related': True theme option to display
#        'searchbox.html',
#        'donate.html',
#    ]
#}
html_sidebars = {
   '**': ['globaltoc.html', 'sourcelink.html', 'searchbox.html'],
   'using/windows': ['windowssidebar.html', 'searchbox.html'],
}


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

# Output file base name for HTML help builder.
htmlhelp_basename = 'eccoaccessdoc'


# -- 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]).
latex_documents = [
    ('index', 'ecco_access_doc.tex', u'ecco_access Documentation',
     u'Andrew Delman', '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', 'eccoaccess_doc', u'ecco_access Documentation',
     [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 = [
    ('index', 'eccoaccess_doc', u'ecco_access Documentation',
     author, 'ecco_accessDocumentation', 'Documentation for the ecco_access Python package to access ECCO state estimate output',
     'Miscellaneous'),
]



# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'http://docs.python.org/': None}
