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 = 'OpenMS'
copyright = '2022, OpenMS Team'
author = 'OpenMS Team'

# -- 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 = [
  'sphinx_copybutton',
  'sphinx.ext.autodoc',
  'sphinx.ext.autosummary',
  'myst_parser',
  'notfound.extension',
  'sphinxcontrib.images',
  'sphinx_inline_tabs',
]

myst_enable_extensions = [
  "tasklist",
  "dollarmath",
  "amsmath",
  "colon_fence",
  "linkify",
  "replacements",
  "linkify_fuzzy_links",
]

autosummary_generate = True
autosummary_imported_members = True
myst_heading_anchors = 4
myst_all_links_external = True

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

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

# 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 = '2.8.0'
# The full version, including alpha/beta/rc tags.
release = '2.8.0'

# -- 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 = 'furo'
html_logo = 'assets/OpenMS_transparent_background.png'

pygments_style = 'sas'

pygments_dark_style = 'rrt'


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

root_doc = 'docs/index'