conf.py

# 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 pathlib
import sys

ROOT_DIR = pathlib.Path(__file__).parent.parent
sys.path.insert(0, str(ROOT_DIR))

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

project = 'csaps'
author = 'Eugene Prilepin'
copyright = f'2017-2025, {author}'  # noqa


def _get_version():
    from csaps import __version__

    return __version__


# The full version, including alpha/beta/rc tags
release = _get_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 = [
    'sphinx.ext.mathjax',
    'sphinx.ext.autodoc',
    'sphinx.ext.autosummary',
    'sphinx.ext.intersphinx',
    'matplotlib.sphinxext.plot_directive',
    'numpydoc',
    'm2r2',
]

intersphinx_mapping = {
    'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None),
}

# Extension settings
plot_apply_rcparams = True
plot_rcparams = {
    'figure.autolayout': 'True',
    'figure.figsize': '5, 3.5',
    'savefig.bbox': 'tight',
    'savefig.facecolor': 'None',
}

plot_formats = [('png', 90)]
plot_include_source = True
plot_html_show_source_link = False
plot_html_show_formats = False

plot_pre_code = """
import numpy as np
from matplotlib import pyplot as plt
from mpl_toolkits.mplot3d import Axes3D
from csaps import csaps

plt.style.use('csaps.mplstyle')

def univariate_data(n=25, seed=1234):
    np.random.seed(seed)
    x = np.linspace(-5., 5., n)
    y = np.exp(-(x/2.5)**2) + (np.random.rand(n) - 0.2) * 0.3
    return x, y
"""

autodoc_member_order = 'bysource'
numpydoc_show_class_members = False

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

master_doc = 'index'

# -- 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 = 'furo'

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

pygments_style = 'tango'
pygments_dark_style = 'stata-dark'

html_theme_options = {
    'light_logo': 'logo.png',
    'dark_logo': 'logo-dark-mode.png',
    'sidebar_hide_name': True,
    'source_repository': 'https://github.com/espdev/csaps',
    'source_branch': 'master',
    'source_directory': 'docs/',
    'top_of_page_buttons': ['view'],
}