conf.py

# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = "Automating GIS Processes"
version = "2023"
release = "2023"

author = "Henrikki Tenkanen, Vuokko Heikinheimo, Håvard Wallin Aagesen, Christoph Fink, Kamyar Hasanzadeh"
copyright = f"2016-{version}"

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

# search for extensions in ../local-extensions/
import pathlib
import sys
sys.path.append(str(pathlib.Path().absolute().parent / "local-extensions"))
print(sys.path)

extensions = [
    "cscnotebookbutton",
    "myst_nb",
]

templates_path = ["_templates"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
source_suffix = {
    ".rst": "restructuredtext",
    ".ipynb": "myst-nb",
    ".myst": "myst-nb",
}
myst_enable_extensions = [
    "colon_fence",
    "substitution",
]
myst_heading_anchors = 3
suppress_warnings = ["mystnb.unknown_mime_type"]

# The following are the main things that need to be updated every year
# These variables are replaced throughout the course documents
# (see the comment for the first item for an example)
myst_substitutions = {

    "year": "2023",  # use {{year}} in markdown files to replace it with the current value
    "starting_date": "Wednesday, 1 November 2023",
    "lectures_weekday_time_location": "Wednesday, 16:15-17:45, Exactum D122",
    "work_sessions_weekday_time_location": "Friday, 12:15-15:45, Physicum A113+A114 (GIS lab)",
    "csc_workspace_join_code": "aut-z2y1a9nw"

}


# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_logo = "static/images/autogis-logo_300x210px.svg"
html_short_title = "AutoGIS"
html_title = ""

html_static_path = ["static"]
html_last_updated_fmt = "%d %B %Y"

html_theme = "sphinx_book_theme"
html_theme_options = {
    "collapse_navigation": False,
    "launch_buttons": {
        "binderhub_url": "https://mybinder.org",
        "notebook_interface": "classic"
    },
    "path_to_docs": "docs",
    "repository_branch": "main",
    "repository_url": "https://github.com/Automating-GIS-processes/site/",
    "use_edit_page_button": True,
    "use_repository_button": True,
}

nb_execution_mode = "force"
nb_execution_timeout = 120  # needed, e.g., when matplotlib updates its font cache
nb_execution_show_tb = True  # show errors

myst_heading_anchors = 4  # create #id links for h1-h4

exclude_patterns = [
    "_build",
    "jupyter_execute",
    "static"
]


# import matplotlib here, otherwise we get the 
# ‘building font cache’ warning in the middle of
# a notebook (when it runs for the first time)
import matplotlib.pyplot