conf.py

# -*- coding: utf-8 -*-
#
# UBC EOAS MOAD Group documentation Sphinx builder configuration file.
#
# This file does only contain a selection of the most common options.
# For a full list see the documentation:
# http://www.sphinx-doc.org/en/stable/config

import datetime
import os


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

project = 'UBC MOAD Docs'
author = 'The UBC EOAS MOAD Group and The University of British Columbia'
copyright_years = (
    "2018"
    if datetime.date.today().year == 2018
    else f"2018-{datetime.date.today():%Y}"
)
copyright = f"{copyright_years}, {author}"

# The short X.Y version
version = ''
# The full version, including alpha/beta/rc tags
release = ''


# -- 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 = [
    'nbsphinx',
    "notfound.extension",
    'sphinx.ext.intersphinx',
    "sphinx_copybutton",
]

intersphinx_mapping = {
    'moadtools':
        ('https://ubc-moad-tools.readthedocs.io/en/latest/', None),
    'nemocmd':
        ('https://nemo-cmd.readthedocs.io/en/latest/', None),
    'salishseacmd':
        ('https://salishseacmd.readthedocs.io/en/latest/', None),
    "salishseadocs":
        ("https://salishsea-meopar-docs.readthedocs.io/en/latest/", None),
}


linkcheck_ignore = [
    # Private GitHub repositories that linkcheck will ignore
    'https://github.com/SalishSeaCast/NEMO-3.6-code',
    'https://github.com/SalishSeaCast/rpn-to-gemlam',
    'https://github.com/SalishSeaCast/XIOS-2',
    'https://github.com/UBC-MOAD/ariane-2.3.0_03',
    # Fails with "403 Client Error: Forbidden" when checked from GitHub Actions
    'https://www.baeldung.com/cs/ssh-intro',
    'https://linux.die.net/man/1/scp',
]
if os.environ.get("GITHUB_ACTIONS") == "true":
    # When we run on GitHub Actions, ignore a collection of URLs that have timeouts due to rate limiting
    linkcheck_ignore.extend(
        [
            r"https://www.alliancecan.ca/.*",
            r"https://forge.ipsl.fr/.*",
        ]
    )
linkcheck_anchors_ignore_for_url = [
    # We get false failures from the Alliance wiki; i.e. anchors that do exist
    # are reported to be broken links. This allows the page URL to be confirmed
    # even if the anchor is not.
    r"https://docs\.alliancecan\.ca/wiki/.*"
]


# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix(es) of source filenames.
# You can specify multiple suffix as a dictionary mapping the file extensions (suffixes)
# of source files to their file types:
source_suffix = {'.rst': 'restructuredtext'}

# The master toctree document.
master_doc = 'index'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = "en"

# 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', '.pixi', 'Thumbs.db', '.DS_Store']

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'


# -- Options for sphinx_copybutton extension ------------------------------

copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: |PS> "
copybutton_prompt_is_regexp = True
copybutton_line_continuation_character = "\\"
# Add a `no-copybutton` class that can be used to suppress the copy button
copybutton_selector = "div:not(.no-copybutton) > div.highlight > pre"


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

# The name of an image file (within the static path) to use as favicon of the
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
html_favicon = "_static/UBC_EOAS_favicon.ico"

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%b %d, %Y'

# If false, no module index is generated.
html_domain_indices = False

# If false, no index is generated.
html_use_index = False

# If true, links to the reST sources are added to the pages.
html_show_sourcelink = True

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
html_show_copyright = True