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

import inspect

# 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
from datetime import date
from importlib import metadata

sys.path.insert(0, os.path.abspath("../"))
sys.path.insert(0, os.path.abspath("../src/"))


# -- Project information -----------------------------------------------------
_TEMPLATE_VERSION = "2.0.0"

project = "fourinsight-engineroom-utils"
copyright = f"{date.today().year}, 4Subsea"
author = "4Subsea"
github_repo = "https://github.com/4Subsea/fourinsight-engineroom-utils-python/"

# The full version, including alpha/beta/rc tags
version = metadata.version("fourinsight-engineroom-utils")
release = version


# -- 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.ext.autosummary",
    "sphinx.ext.autodoc",
    "sphinx.ext.napoleon",
    "sphinx.ext.intersphinx",
    "sphinx.ext.linkcode",
    "myst_parser",
]
autosummary_generate = True


def linkcode_resolve(domain, info):
    if domain != "py":
        return None
    if not info["module"]:
        return None

    obj = sys.modules[info["module"]]

    for part in info["fullname"].split("."):
        obj = getattr(obj, part)
    obj = inspect.unwrap(obj)

    try:
        path = os.path.relpath(inspect.getfile(obj))
        src, lineno = inspect.getsourcelines(obj)

        path = f"{github_repo}blob/main/{path}#L{lineno}-L{lineno + len(src) - 1}"

    except:
        path = None
    return path


# Napoleon settings
napoleon_google_docstring = False
napoleon_numpy_docstring = True

# Intershpinx mapping
intersphinx_mapping = {
    "python": ("https://docs.python.org/3", None),
}

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

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


# -- 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 = "pydata_sphinx_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"]
html_css_files = ["css/custom.css"]

html_logo = "_static/4insight-logo.svg"

html_context = {"default_mode": "light"}
html_favicon = "_static/favicon.png"
html_sidebars = {"**": ["sidebar-nav-bs.html"]}

html_theme_options = {
    "logo": {"link": "http://docs.4insight.io", "text": "DOCUMENTATION"},
    "navbar_end": ["navbar-icon-links.html"],
    "icon_links": [
        {
            "name": "GitHub",
            "url": github_repo,
            "icon": "fab fa-github",
        },
        {
            "name": "PyPI",
            "url": "https://pypi.org/project/fourinsight-engineroom-utils/",
            "icon": "fas fa-box",
        },
    ],
    "navbar_align": "left",
}