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
from unittest.mock import MagicMock


class Mock(MagicMock):
    @classmethod
    def __getattr__(cls, name):
        return MagicMock()


class ModuleMock(Mock):
    """
    Used to add python libraries. If not added that way python modules written in C can't be imported by sphinx autodoc.

    """

    def __init__(self, path="", *args, **kwargs):
        super().__init__(*args, *kwargs)
        self.path = path

    def __getattr__(self, name):
        if name in ("_mock_methods", "_mock_unsafe"):
            return super(ModuleMock, self).__getattr__(name)
        return ModuleMock(path=self.path + "." + name)

    def __repr__(self):
        return self.path


# for knime.scripting._deprecated._table.py, knime.api.schema.py
sys.path.insert(
    0, os.path.abspath(os.path.join("..", "org.knime.python3", "src", "main", "python"))
)

# for knime.extension.nodes.py
sys.path.insert(
    0,
    os.path.abspath(
        os.path.join("..", "org.knime.python3.nodes", "src", "main", "python")
    ),
)

# for knime_io.py
sys.path.insert(
    0,
    os.path.abspath(
        os.path.join("..", "org.knime.python3.scripting", "src", "main", "python")
    ),
)

# for knime/views.py
sys.path.insert(
    0,
    os.path.abspath(
        os.path.join("..", "org.knime.python3.views", "src", "main", "python")
    ),
)

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

project = "KNIME Python API"
copyright = "2021, KNIME GmbH"
author = "Carsten Haubold, Adrian Nembach, Marcel Wiedenmann, Benjamin Wilhelm"

# -- 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.autodoc",
    "sphinx.ext.napoleon",
    "sphinx.ext.autosectionlabel",
]

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

# mock import that sphinx recognizes them
MOCK_MODULES = ["numpy", "pandas", "pyarrow", "py4j.clientserver", "pytz", "dateutil"]

sys.modules.update((mod_name, ModuleMock()) for mod_name in MOCK_MODULES)

# -- 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"
html_static_path = ["_static"]
html_logo = "KNIME_Logo.png"
html_theme_options = {
    "logo_only": True,
    "display_version": True,
    "style_nav_header_background": "white",
    "collapse_navigation": False,
    "analytics_anonymize_ip": True,
}
html_js_files = ["js/redirect.js"]

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


# -- Extension configuration -------------------------------------------------
master_doc = "index"
# html_css_files = ["custom.css"]

html_css_files = [
    "css/custom.css",
]