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('.'))
import datetime


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

project = 'Sigma2/NRIS documentation'
copyright = f'{datetime.datetime.now().year}, Sigma2/NRIS'
author = 'Sigma2/NRIS'

# Logo setup
html_favicon = 'img/nris.ico'
html_logo = 'img/NRIS Logo.svg'
html_css_files = ['nris.css']

html_title = 'Sigma2 documentation'
html_short_title = 'Sigma2'


# -- 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_parser',
    'sphinx_tabs.tabs',
    'sphinx_reredirects',
]

# 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', 'Thumbs.db', '.DS_Store', 'venv', '_book', 'node_modules', 'README.md']

# https://documatt.gitlab.io/sphinx-reredirects/usage.html
redirects = {
     "files_storage/nird_migration": "nird/migration.html"
     }

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

# this configures where "view page source" (top right on rendered page) points to
html_context = {
    'display_github': True,
    'github_user': 'UNINETTSigma2',
    'github_repo': 'documentation',
    'github_version': 'master/' ,
}

# ignoring these because they are behind vpn/login and linkchecker cannot verify these
# or because they don't really exist
linkcheck_ignore = [
    'https://rt.uninett.no/SelfService',
    r'localhost:\d+',
    r'https://desktop.saga.sigma2.no:\d+',
    r'https://desktop.fram.sigma2.no:\d+',
    'https://lifeportal.saga.sigma2.no',
    'http://www.linuxconfig.org/Bash_scripting_Tutorial',
    'http://www.wannier.org',
    'https://hpc.llnl.gov/training/tutorials/introduction-parallel-computing-tutorial#ExamplesPI',  # some problem with SSL certificate not recognized by CI
    'https://hpc.llnl.gov/training/tutorials/introduction-parallel-computing-tutorial#ModelsOverview',  # some problem with SSL certificate not recognized by CI
    'https://www.ccp4.ac.uk/',  # SSL certificate issue
    'https://www.vasp.at',  # SSL certificate issue
]


# this loads extra JS code which we use to analyze web traffic
def setup(app):
    app.add_js_file("https://siteimproveanalytics.com/js/siteanalyze_6036825.js", loading_method="async")