conf.py

# Configuration file for the Sphinx documentation builder.
#
# -- 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 os
import platform
# import sys
# sys.path.insert(0, os.path.abspath('.'))


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

project = 'Caltech/IPAC--IRSA Demo Notebooks'
copyright = '2022-2024, IRSA developers'
author = 'IRSA developers'


# -- 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 = [
    'myst_nb',
    'sphinx_copybutton',
]

# 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', 'notes', '.tox', '.tmp', '.pytest_cache', 'README.md']

# MyST-NB configuration
nb_execution_timeout = 900
nb_merge_streams = True

nb_execution_excludepatterns = []

if 'CIRCLECI' in os.environ:
    # Workaround for https://github.com/Caltech-IPAC/irsa-tutorials/issues/6
    # Some of the notebooks run into a DeadKernelError on CircleCI, but do execute and render on GHA.
    # Ignore them here.
    nb_execution_excludepatterns += ['wise-allwise-catalog-demo.md', 'Parallelize_Convolution.md']

if 'CI' in os.environ:
    # Both NEOWISE parquet notebooks work with large data that doesn't work within CircleCI or GHA resource limits
    nb_execution_excludepatterns += ['neowise-source-table-strategies.md', 'neowise-source-table-lightcurves.md']

if platform.platform().startswith("mac") or platform.platform().startswith("win"):
    # The way the notebooks use the multiprocessing module is known to not work on non-Linux
    nb_execution_excludepatterns += ['Parallelize_Convolution.md', 'neowise-source-table-lightcurves.md']

# -- 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_book_theme'
html_title = 'IRSA Demo Notebooks'
html_logo = '_static/irsa_logo.png'
#html_favicon = '_static/favicon.ico'
html_theme_options = {
    "github_url": "https://github.com/Caltech-IPAC/irsa-tutorials",
    "repository_url": "https://github.com/Caltech-IPAC/irsa-tutorials",
    "repository_branch": "main",
    "use_repository_button": True,
    "use_issues_button": True,
    "use_edit_page_button": True,
    "launch_buttons": {"binderhub_url": "https://mybinder.org",},
    "logo": {
        "link": "https://irsa.ipac.caltech.edu/",
        "alt_text": "NASA/IPAC Infrared Science Archive - Home",
    },
    "home_page_in_toc": True,
}


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

# myst configurations
myst_heading_anchors = 4