diff --git a/conf.py b/conf.py deleted file mode 100644 index 579b5c72..00000000 --- a/conf.py +++ /dev/null @@ -1,99 +0,0 @@ -# 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-2025, 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', -] - -myst_enable_extensions = [ - 'dollarmath', -] - -# 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 = 1200 -nb_merge_streams = True -nb_execution_mode = "cache" -nb_scroll_outputs = 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 (hitting the memory limit) 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/irsa-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 diff --git a/deployed_notebooks_manifest.in b/deployed_notebooks_manifest.in index ee12a1c1..5cb21450 100644 --- a/deployed_notebooks_manifest.in +++ b/deployed_notebooks_manifest.in @@ -1,7 +1,6 @@ tutorials/cloud_access/cloud-access-intro.md tutorials/cloud_access/euclid-cloud-access.md tutorials/cosmodc2/cosmoDC2_TAP_access.md -tutorials/euclid_access/.gitkeep tutorials/euclid_access/1_Euclid_intro_MER_images.md tutorials/euclid_access/2_Euclid_intro_MER_catalog.md tutorials/euclid_access/3_Euclid_intro_1D_spectra.md diff --git a/ignore_tutorials/ignore_rendering b/ignore_tutorials/ignore_rendering_execution similarity index 100% rename from ignore_tutorials/ignore_rendering rename to ignore_tutorials/ignore_rendering_execution diff --git a/myst.yml b/myst.yml index d4095db7..d0d10aac 100644 --- a/myst.yml +++ b/myst.yml @@ -7,6 +7,10 @@ project: keywords: [astronomy] authors: [IRSA Scientists and Developers] github: https://github.com/Caltech-IPAC/irsa-tutorials/ + jupyter: + binder: + repo: https://github.com/Caltech-IPAC/irsa-tutorials/ + url: https://mybinder.org settings: output_matplotlib_strings: remove extends: diff --git a/tox.ini b/tox.ini index d0ba96ea..64730066 100644 --- a/tox.ini +++ b/tox.ini @@ -62,7 +62,7 @@ commands = bash -c 'if [[ $CI == true ]]; then cat ignore_tutorials/ignore_gha_testing >> ignore_testing; fi' bash -c 'if [[ $CIRCLECI == true ]]; then cat ignore_tutorials/ignore_circleci_testing >> ignore_testing; fi' - buildhtml: bash -c 'cat ignore_tutorials/ignore_rendering >> ignore_testing' + buildhtml: bash -c 'cat ignore_tutorials/ignore_rendering_execution >> ignore_testing' # We only want to run CI in PRs for the notebooks we touched !buildhtml: bash -c 'if [[ $GITHUB_EVENT_NAME == pull_request && -z "$(grep force_run:all_tests ${GITHUB_EVENT_PATH})" ]]; then git fetch origin main --depth=1; git diff origin/main --name-only tutorials | grep .md; else find tutorials -name "*.md"; fi | grep -vf ignore_testing/ignore_testing | xargs jupytext --to notebook ' @@ -75,7 +75,6 @@ commands = # Status check is a workaround until https://github.com/jupyter-book/mystmd/issues/2113 is fixed buildhtml: bash -c "jupyter-book build --execute --html 2>&1 | tee /tmp/mystbuild.log" buildhtml: bash -c "if grep -q 'Traceback .most recent call last.' /tmp/mystbuild.log; then exit 1; fi" - buildhtml: bash -c "rm _build/html/*thebe*.js" pip_pre = predeps: true