content/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 os
# import sys
# sys.path.insert(0, os.path.abspath('.'))


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

project = 'Train the trainer workshop'
copyright = 'CodeRefinery project'
author = 'The contributors'
github_user = 'coderefinery'
github_repo_name = 'train-the-trainer'  # auto-detected from dirname if blank
github_version = 'master/content/' # with trailing slash


# -- 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 = [
    # githubpages just adds a .nojekyll file
    'sphinx.ext.githubpages',
    'sphinx_lesson',
    'sphinx_design',
    #'sphinx.ext.intersphinx',
    'sphinx_rtd_theme_ext_color_contrast',
    'sphinx_coderefinery_branding',
    'sphinxcontrib.youtube',
    'sphinx_localtime',
]

myst_enable_extensions = [
    'colon_fence',   # ::: can be used instead of ``` for better rendering
    ]

# Settings for myst_nb:
# https://myst-nb.readthedocs.io/en/latest/use/execute.html#triggering-notebook-execution
#jupyter_execute_notebooks = "off"
#jupyter_execute_notebooks = "auto"   # *only* execute if at least one output is missing.
#jupyter_execute_notebooks = "force"
nb_execution_mode = "cache"

# 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 = ['README*', '_build', 'Thumbs.db', '.DS_Store',
                    'jupyter_execute', '*venv*']


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


# HTML context:
from os.path import dirname, realpath, basename
html_context = {'display_github': True,
                'github_user': github_user,
                # Auto-detect directory name.  This can break, but
                # useful as a default.
                'github_repo': github_repo_name or basename(dirname(realpath(__file__))),
                'github_version': github_version,
               }

# Intersphinx mapping.  For example, with this you can use
# :py:mod:`multiprocessing` to link straight to the Python docs of that module.
# List all available references:
#   python -msphinx.ext.intersphinx https://docs.python.org/3/objects.inv
#intersphinx_mapping = {
#    #'python': ('https://docs.python.org/3', None),
#    #'sphinx': ('https://www.sphinx-doc.org/', None),
#    }