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

# -- Mock imports --------------------------------------------------------------

# Adapted from
# http://blog.rtwilson.com/how-to-make-your-sphinx-documentation-compile-with-readthedocs-when-youre-using-numpy-and-scipy/

import os
import sys
from MuyGPyS import __version__

# import mock
# import sys

# MOCK_MODULES = [
#     'numpy', 'scipy', 'scikit-learn', 'absl-py', 'pybind11', 'hnswlib'
# ]
# for mod_name in MOCK_MODULES:
#     sys.modules[mod_name] = mock.Mock()

autodoc_mock_imports = [
    "numpy",
    "scipy",
    "scikit-learn",
    "sklearn",
    "absl-py",
    "pybind11",
    "hnswlib",
    "torch",
]

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

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

project = "MuyGPyS"
copyright = "2021, Lawrence Livermore National Security, LLC"
author = "Benjamin W. Priest"

# The short X.Y.Z version
version = "v" + __version__
# The full version, including alpha/beta/rc tags
release = "beta"


# -- 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.autodoc",
    "sphinx.ext.intersphinx",
    "sphinx.ext.autosummary",
    "sphinx.ext.mathjax",
    "sphinx.ext.viewcode",
    "sphinx.ext.napoleon",
    "sphinx_autodoc_typehints",
    "nbsphinx",
]

# (Dis/En)able notebook execution
# Uncomment to turn off notebook execution
# nbsphinx_execute = 'never'

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


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

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