<commit_before># -*- coding: utf-8 -*-
#
# librosa documentation build configuration file, created by
# sphinx-quickstart on Tue Jun 25 13:12:33 2013.
#
# 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.

#
# To build multi-versions, run the following at the base directory
#   $ sphinx-multiversion docs/ build/html/
#

import os
import sys
from pathlib import Path
import sphinx

# 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("../"))

# This song and dance enables builds from outside the docs directory
srcpath = os.path.abspath(Path(os.path.dirname(__file__)) / '..')
sys.path.insert(0, srcpath)

# Purge old imports, trying to hack around sphinx-multiversion global environment
removals = [_ for _ in sys.modules if 'librosa' in _]
for _ in removals:
    del sys.modules[_]

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

# If your documentation needs a minimal Sphinx version, state it here.
if sphinx.__version__ < "2.0":
    raise RuntimeError("Sphinx 2.0 or newer is required")

needs_sphinx = "2.0"

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

from importlib.machinery import SourceFileLoader

librosa_version = SourceFileLoader(
    "librosa.version", os.path.abspath(Path(srcpath) / 'librosa' / 'version.py')
).load_module()

# The short X.Y version.
version = librosa_version.version
# The full version, including alpha/beta/rc tags.
release = librosa_version.version

# 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",  # function indexing
    "sphinx.ext.autosummary",  # for older builds
    "sphinx.ext.viewcode",  # source linkage
    "sphinx.ext.intersphinx",  # cross-linkage
    "sphinx.ext.mathjax",
    "sphinx_gallery.gen_gallery",  # advanced examples
    "numpydoc",  # docstring examples
    "matplotlib.sphinxext.plot_directive",  # docstring examples
    "sphinxcontrib.inkscapeconverter",  # used for badge / logo conversion in tex 
    "sphinx_multiversion"  # historical builds
]

autosummary_generate = True

# --------
# Doctest
# --------

doctest_global_setup = """
import numpy as np
import scipy
import librosa
np.random.seed(123)
np.set_printoptions(precision=3, linewidth=64, edgeitems=2, threshold=200)
"""

numpydoc_show_class_members = False

# ------------------------------------------------------------------------------
# Plot
# ------------------------------------------------------------------------------
plot_pre_code = (
    doctest_global_setup
    + """
import matplotlib
import librosa
import librosa.display
matplotlib.rcParams['figure.constrained_layout.use'] = librosa.__version__ >= '0.8'
"""
)
plot_include_source = True
plot_html_show_source_link = False
plot_formats = [("png", 100), ("pdf", 100)]
plot_html_show_formats = False

font_size = 12  # 13*72/96.0  # 13 px

plot_rcparams = {
    "font.size": font_size,
    "legend.loc": "upper right",
    "legend.frameon": True,
    "legend.framealpha": 0.95,
    "axes.xmargin": 0,
    "axes.ymargin": 0,
    "axes.titlesize": font_size,
    "axes.labelsize": font_size,
    "xtick.labelsize": font_size,
    "ytick.labelsize": font_size,
    "legend.fontsize": font_size,
    "figure.subplot.bottom": 0.2,
    "figure.subplot.left": 0.2,
    "figure.subplot.right": 0.9,
    "figure.subplot.top": 0.85,
    "figure.subplot.wspace": 0.4,
    "text.usetex": False,
}


def reset_mpl(gallery_conf, fname):
    global plot_rcparams

    import matplotlib
    import matplotlib.pyplot as plt
    import librosa

    matplotlib.rcParams.update(**plot_rcparams)

    # Only use constrained layout in 0.8 and above
    matplotlib.rcParams['figure.constrained_layout.use'] = librosa.__version__ >= '0.8'
    plt.close('all')


# Gallery
sphinx_gallery_conf = {
    "examples_dirs": "examples/",
    "gallery_dirs": "auto_examples",
    "backreferences_dir": None,
    "matplotlib_animations": True,
    "reference_url": {
        "sphinx_gallery": None,
        "librosa": None,
        "numpy": "https://numpy.org/doc/stable/",
        "np": "https://numpy.org/doc/stable/",
        "scipy": "https://docs.scipy.org/doc/scipy/",
        "matplotlib": "https://matplotlib.org/stable/",
        "sklearn": "https://scikit-learn.org/stable/",
        "resampy": "https://resampy.readthedocs.io/en/stable/",
        "pyrubberband": "https://pyrubberband.readthedocs.io/en/stable/",
        "samplerate": "https://python-samplerate.readthedocs.io/en/latest/",
        "pooch": "https://www.fatiando.org/pooch/latest/",
        "soxr": "https://python-soxr.readthedocs.io/en/latest/",
        "mir_eval": "https://craffel.github.io/mir_eval/",
        "IPython": "https://ipython.readthedocs.io/en/stable/",
    },
    "reset_modules": (reset_mpl,),
    'capture_repr': ('_repr_html_',),
}

# Generate plots for example sections
numpydoc_use_plots = True


intersphinx_mapping = {
    "python": ("https://docs.python.org/3", None),
    "numpy": ("https://numpy.org/doc/stable/", None),
    "np": ("https://numpy.org/doc/stable/", None),
    "scipy": ("https://docs.scipy.org/doc/scipy/", None),
    "matplotlib": ("https://matplotlib.org/stable/", None),
    "sklearn": ("https://scikit-learn.org/stable/", None),
    "resampy": ("https://resampy.readthedocs.io/en/stable/", None),
    "soundfile": ("https://pysoundfile.readthedocs.io/en/latest", None),
    "samplerate": ("https://python-samplerate.readthedocs.io/en/latest/", None),
    "pyrubberband": ("https://pyrubberband.readthedocs.io/en/stable/", None),
    "soxr": ("https://python-soxr.readthedocs.io/en/latest/", None),
    "mir_eval": ("https://craffel.github.io/mir_eval/", None),
    "IPython": ("https://ipython.readthedocs.io/en/stable/", None),
}


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

html_sidebars = {'*': ["versions.html"]}


# The suffix of source filenames.<commit_msg>fixing intersphinx and sphinx-gallery configuration<commit_after># -*- coding: utf-8 -*-
#
# librosa documentation build configuration file, created by
# sphinx-quickstart on Tue Jun 25 13:12:33 2013.
#
# 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.

#
# To build multi-versions, run the following at the base directory
#   $ sphinx-multiversion docs/ build/html/
#

import os
import sys
from pathlib import Path
import sphinx

# 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("../"))

# This song and dance enables builds from outside the docs directory
srcpath = os.path.abspath(Path(os.path.dirname(__file__)) / '..')
sys.path.insert(0, srcpath)

# Purge old imports, trying to hack around sphinx-multiversion global environment
removals = [_ for _ in sys.modules if 'librosa' in _]
for _ in removals:
    del sys.modules[_]

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

# If your documentation needs a minimal Sphinx version, state it here.
if sphinx.__version__ < "2.0":
    raise RuntimeError("Sphinx 2.0 or newer is required")

needs_sphinx = "2.0"

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

from importlib.machinery import SourceFileLoader

librosa_version = SourceFileLoader(
    "librosa.version", os.path.abspath(Path(srcpath) / 'librosa' / 'version.py')
).load_module()

# The short X.Y version.
version = librosa_version.version
# The full version, including alpha/beta/rc tags.
release = librosa_version.version

# 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",  # function indexing
    "sphinx.ext.autosummary",  # for older builds
    "sphinx.ext.viewcode",  # source linkage
    "sphinx.ext.intersphinx",  # cross-linkage
    "sphinx.ext.mathjax",
    "sphinx_gallery.gen_gallery",  # advanced examples
    "numpydoc",  # docstring examples
    "matplotlib.sphinxext.plot_directive",  # docstring examples
    "sphinxcontrib.inkscapeconverter",  # used for badge / logo conversion in tex 
    "sphinx_multiversion"  # historical builds
]

autosummary_generate = True

# --------
# Doctest
# --------

doctest_global_setup = """
import numpy as np
import scipy
import librosa
np.random.seed(123)
np.set_printoptions(precision=3, linewidth=64, edgeitems=2, threshold=200)
"""

numpydoc_show_class_members = False

# ------------------------------------------------------------------------------
# Plot
# ------------------------------------------------------------------------------
plot_pre_code = (
    doctest_global_setup
    + """
import matplotlib
import librosa
import librosa.display
matplotlib.rcParams['figure.constrained_layout.use'] = librosa.__version__ >= '0.8'
"""
)
plot_include_source = True
plot_html_show_source_link = False
plot_formats = [("png", 100), ("pdf", 100)]
plot_html_show_formats = False

font_size = 12  # 13*72/96.0  # 13 px

plot_rcparams = {
    "font.size": font_size,
    "legend.loc": "upper right",
    "legend.frameon": True,
    "legend.framealpha": 0.95,
    "axes.xmargin": 0,
    "axes.ymargin": 0,
    "axes.titlesize": font_size,
    "axes.labelsize": font_size,
    "xtick.labelsize": font_size,
    "ytick.labelsize": font_size,
    "legend.fontsize": font_size,
    "figure.subplot.bottom": 0.2,
    "figure.subplot.left": 0.2,
    "figure.subplot.right": 0.9,
    "figure.subplot.top": 0.85,
    "figure.subplot.wspace": 0.4,
    "text.usetex": False,
}


def reset_mpl(gallery_conf, fname):
    global plot_rcparams

    import matplotlib
    import matplotlib.pyplot as plt
    import librosa

    matplotlib.rcParams.update(**plot_rcparams)

    # Only use constrained layout in 0.8 and above
    matplotlib.rcParams['figure.constrained_layout.use'] = librosa.__version__ >= '0.8'
    plt.close('all')


# Gallery
sphinx_gallery_conf = {
    "examples_dirs": "examples/",
    "gallery_dirs": "auto_examples",
    "backreferences_dir": None,
    "matplotlib_animations": True,
    "reference_url": {
        "librosa": None,
    },
    "reset_modules": (reset_mpl,),
    'capture_repr': ('_repr_html_',),
}

# Generate plots for example sections
numpydoc_use_plots = True


intersphinx_mapping = {
    "python": ("https://docs.python.org/3", None),
    "numpy": ("https://numpy.org/doc/stable/", None),
    "np": ("https://numpy.org/doc/stable/", None),
    "scipy": ("https://docs.scipy.org/doc/scipy/", None),
    "matplotlib": ("https://matplotlib.org/stable/", None),
    "sklearn": ("https://scikit-learn.org/stable/", None),
    "resampy": ("https://resampy.readthedocs.io/en/stable/", None),
    "soundfile": ("https://pysoundfile.readthedocs.io/en/latest", None),
    "samplerate": ("https://python-samplerate.readthedocs.io/en/latest/", None),
    "pyrubberband": ("https://pyrubberband.readthedocs.io/en/stable/", None),
    "pooch": ("https://www.fatiando.org/pooch/latest/", None),
    "soxr": ("https://python-soxr.readthedocs.io/en/latest/", None),
    "mir_eval": ("https://craffel.github.io/mir_eval/", None),
    "IPython": ("https://ipython.readthedocs.io/en/stable/", None),
}


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

html_sidebars = {'*': ["versions.html"]}


# The suffix of source filenames.
{'fraction_non_alphanumeric': 0.1706282513005202, 'fraction_numerical': 0.011364545818327331, 'mean_word_length': 3.2765229295003424, 'pattern_counts': {'":': 90, '<': 5, '<?xml version=': 0, '>': 7, 'https://': 39, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '561019', 'n_tokens_mistral': 4345, 'n_tokens_neox': 4133, 'n_words': 994}