conf.py

# -*- coding: utf-8 -*-
#
# Triton user guide documentation build configuration file, created by
# sphinx-quickstart on Thu Jun 15 12:18:55 2017.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

import importlib
import sys
import os
on_rtd = os.environ.get('READTHEDOCS') == 'True'

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

# -- General configuration ------------------------------------------------

html_context = { }

# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
    'sphinx.ext.todo',
    'sphinx.ext.ifconfig',
    'sphinx.ext.mathjax',
    'sphinx_toolbox.collapse',
]
# I try to make these docs buildable even without any extra dependencies
# (nothing other than what you can find in Ubuntu).  So, add these to
# extensions only if they are importable:
optional_modules = [
    'sphinx_rtd_theme_ext_color_contrast',
    'sphinx_copybutton',
    'sphinx_lesson.directives',
    'sphinx_tabs.tabs',
    'sphinx_togglebutton',
    'sphinx_ext_substitution',
    'sphinx_plausible',
    'sphinxext.opengraph',
    'sphinx_minipres',
    'sphinxext.rediraffe'
    ]
if on_rtd or 'GITSTAMP' in os.environ:
    optional_modules.append('sphinx_gitstamp')
for mod in optional_modules:
    try:
        importlib.import_module(mod)
        extensions.append(mod)
    except ImportError:
        print('Module %s is not available'%mod)

plausible_enabled = on_rtd
plausible_domain = 'scicomp.aalto.fi'
plausible_script = 'https://plausible.cs.aalto.fi/js/plausible.js'

ogp_site_url = "https://scicomp.aalto.fi/"
ogp_site_name = "Aalto Scientific Computing"
ogp_image = "_static/asc-socialshare-02.png"
ogp_image_alt = "ASC hexagon logo; Aalto Scientific Computing; Data, Software, Computing, HPC, and Training."
ogp_custom_meta_tags = ['<meta property="twitter:creator" content="@SciCompAalto" />']

rediraffe_redirects = '_meta/redirects.txt'

# Add timestamps from git
gitstamp_fmt = "%Y %b %d"
# dates earlier than this are highlighted in red in the theme.  Only
# years supported so far due to %b time format.  Can be overwritten by
# `:gitstamp_warn_date` in page metadata.
html_context['gitstamp_warn'] = '2022'

# 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 list of string:
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'

# The encoding of source files.
#source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'Aalto Scientific Computing'
copyright = u'2024, Aalto Science-IT and contributors'
author = u'Aalto Science-IT'

copybutton_exclude = '.linenos, .gp'

# Substitutions
substitute_path = ['_substitutions/']

supress_warnings = [
    #'toc.excluded',  # This does not work to hide the orphan page warnings
    ]

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
#version = u'0.1'
# The full version, including alpha/beta/rc tags.
#release = u'0.1'
import datetime
#version = datetime.date.today().strftime('%Y-%m-%d')
#release = datetime.date.today().strftime('%Y-%m-%d')
version = release = ''

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

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = [
    '_build',
    '_meta',
    '_substitutions',
    'triton/apps/TEMPLATE.rst',
    'venv*'
    ]

# The reST default role (used for this markup: `text`) to use for all
# documents.
default_role = 'any'

# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False

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

# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []

# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True


# -- Options for HTML output ----------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.

html_css_files = [
    "theme_overrides.css",
]

html_js_files = [
    "redirect-to-https.js",
]

html_theme = "sphinx_rtd_theme"
if on_rtd:
    os.system('git fetch --unshallow')
    os.system('pip freeze')
#else:
#    import sphinx_rtd_theme
#    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

# Theme options are theme-specific and customize the look and feel of a theme
# further.  For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
html_theme_options = {
    #'display_version': False, # no longer needed in 3.0.0
    'navigation_depth': 5,
    'prev_next_buttons_location': None,
    #'canonical_url': 'https://scicomp.aalto.fi/',
    'sticky_navigation': False,  # nav sidebar scrolls with pages
    'version_selector': False, # for RTD
    'style_external_links': True,
    }
html_context.update(
    {'display_github': True,
     'github_user': 'AaltoSciComp',
     'github_repo': 'scicomp-docs',
     'github_version': 'master/',
    })

# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []

# The name for this set of Sphinx documents.  If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
html_title = 'Aalto Scientific Computing (ASC)'

# A shorter title for the navigation bar.  Default is the same as html_title.
#html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
html_logo = '_meta/logo-hexagons-02-compact-white.svg'

# The name of an image file (relative to this directory) to use as a favicon of
# the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
html_favicon = '_static/logo-hexagons-02-compact.svg.ico'

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

# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []

# 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 true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}

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

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

# If true, the index is split into individual pages for each letter.
#html_split_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
html_show_sphinx = False

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

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it.  The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None

# Language to be used for generating the HTML full-text search index.
# Sphinx supports the following languages:
#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
#html_search_language = 'en'

# A dictionary with options for the search language support, empty by default.
# Now only 'ja' uses this config value
#html_search_options = {'type': 'default'}

# The name of a javascript file (relative to the configuration directory) that
# implements a search results scorer. If empty, the default will be used.
#html_search_scorer = 'scorer.js'

# Output file base name for HTML help builder.
htmlhelp_basename = 'AaltoScicomp'

# -- Options for LaTeX output ---------------------------------------------

latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
#'preamble': '',

# Latex figure (float) alignment
#'figure_align': 'htbp',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
#  author, documentclass [howto, manual, or own class]).
latex_documents = [
    (master_doc, 'AaltoScicomp.tex', u'Aalto scientific computing guide',
     u'Aalto Science-IT', 'manual'),
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False

# If true, show page references after internal links.
#latex_show_pagerefs = False

# If true, show URL addresses after external links.
#latex_show_urls = False

# Documents to append as an appendix to all manuals.
#latex_appendices = []

# If false, no module index is generated.
#latex_domain_indices = True


# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    (master_doc, 'aaltoscicomp', u'Aalto scientific computing',
     [author], 1)
]

# If true, show URL addresses after external links.
#man_show_urls = False


# -- Options for Texinfo output -------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
#  dir menu entry, description, category)
texinfo_documents = [
    (master_doc, 'AaltoScicomp', u'Aalto scientific computing',
     author, 'AaltoScicomp', 'One line description of project.',
     'Miscellaneous'),
]

# Documents to append as an appendix to all manuals.
#texinfo_appendices = []

# If false, no module index is generated.
#texinfo_domain_indices = True

# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'

# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False

# -- Options for Epub output -------------------------------------------
epub_basename = 'AaltoScicomp'
epub_title = 'Aalto scientefic computing guide'
epub_author = 'Aalto Science-IT'


# -- Own options -------------------------------------------------------

mathjax_path = 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-MML-AM_CHTML'


# Debugging:
#if on_rtd:
#    os.system("pip freeze")