opentelemetry-python-contrib/docs/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:
# http://www.sphinx-doc.org/en/master/config

# -- 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 configparser import ConfigParser
from os import listdir
from os.path import isdir, join

# configure django to avoid the following exception:
# django.core.exceptions.ImproperlyConfigured: Requested settings, but settings
# are not configured. You must either define the environment variable
# DJANGO_SETTINGS_MODULE or call settings.configure() before accessing settings.
from django.conf import settings

settings.configure()

source_dirs = []

exp = "../exporter"
exp_dirs = [
    os.path.abspath("/".join([exp, f, "src"]))
    for f in listdir(exp)
    if isdir(join(exp, f))
]

instr = "../instrumentation"
instr_dirs = [
    os.path.abspath("/".join([instr, f, "src"]))
    for f in listdir(instr)
    if isdir(join(instr, f))
]

instr_genai = "../instrumentation-genai"
instr_genai_dirs = [
    os.path.abspath("/".join([instr_genai, f, "src"]))
    for f in listdir(instr_genai)
    if isdir(join(instr_genai, f))
]

prop = "../propagator"
prop_dirs = [
    os.path.abspath("/".join([prop, f, "src"]))
    for f in listdir(prop)
    if isdir(join(prop, f))
]

sdk_ext = "../sdk-extension"
sdk_ext_dirs = [
    os.path.abspath("/".join([sdk_ext, f, "src"]))
    for f in listdir(sdk_ext)
    if isdir(join(sdk_ext, f))
]

resource = "../resource"
resource_dirs = [
    os.path.abspath("/".join([resource, f, "src"]))
    for f in listdir(resource)
    if isdir(join(resource, f))
]

util = "../util"
util_dirs = [
    os.path.abspath("/".join([util, f, "src"]))
    for f in listdir(util)
    if isdir(join(util, f))
]

opamp = "../opamp"
opamp_dirs = [
    os.path.abspath("/".join([opamp, f, "src"]))
    for f in listdir(opamp)
    if isdir(join(opamp, f))
]

sys.path[:0] = (
    exp_dirs
    + instr_dirs
    + instr_genai_dirs
    + sdk_ext_dirs
    + prop_dirs
    + resource_dirs
    + util_dirs
    + opamp_dirs
)

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

project = "OpenTelemetry Python Contrib"
copyright = "OpenTelemetry Authors"  # pylint: disable=redefined-builtin
author = "OpenTelemetry Authors"


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

# Easy automatic cross-references for `code in backticks`
default_role = "any"

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
    # API doc generation
    "sphinx.ext.autodoc",
    # Support for google-style docstrings
    "sphinx.ext.napoleon",
    # Infer types from hints instead of docstrings
    "sphinx_autodoc_typehints",
    # Add links to source from generated docs
    "sphinx.ext.viewcode",
    # Link to other sphinx docs
    "sphinx.ext.intersphinx",
    # Add a .nojekyll file to the generated HTML docs
    # https://help.github.com/en/articles/files-that-start-with-an-underscore-are-missing
    "sphinx.ext.githubpages",
    # Support external links to different versions in the Github repo
    "sphinx.ext.extlinks",
]

intersphinx_mapping = {
    "python": ("https://docs.python.org/3/", None),
    "psycopg": ("https://www.psycopg.org/psycopg3/docs/", None),
    "psycopg2": ("https://www.psycopg.org/docs/", None),
    "opentracing": (
        "https://opentracing-python.readthedocs.io/en/latest/",
        None,
    ),
    "aiohttp": ("https://docs.aiohttp.org/en/stable/", None),
    "wrapt": ("https://wrapt.readthedocs.io/en/latest/", None),
    "pymongo": ("https://pymongo.readthedocs.io/en/stable/", None),
    "opentelemetry": (
        "https://opentelemetry-python.readthedocs.io/en/latest/",
        None,
    ),
    "redis": ("https://redis.readthedocs.io/en/latest/", None),
    "fsspec": ("https://filesystem-spec.readthedocs.io/en/latest/", None),
}

# http://www.sphinx-doc.org/en/master/config.html#confval-nitpicky
# Sphinx will warn about all references where the target cannot be found.
nitpicky = True
# Sphinx does not recognize generic type TypeVars
# Container supposedly were fixed, but does not work
# https://github.com/sphinx-doc/sphinx/pull/3744
nitpick_ignore = [
    (
        "py:class",
        "opamp_pb2.RemoteConfigStatus",
    ),
    (
        "py:class",
        "opamp_pb2.EffectiveConfig",
    ),
]

cfg = ConfigParser()
cfg.read("./nitpick-exceptions.ini")
mcfg = cfg["default"]


def getlistcfg(strval):
    return [
        val.strip()
        for line in strval.split("\n")
        for val in line.split(",")
        if val.strip()
    ]


ignore_categories = [
    "py-class",
    "py-func",
    "py-exc",
    "py-obj",
    "py-data",
    "any",
]

for category in ignore_categories:
    if category in mcfg:
        items = getlistcfg(mcfg[category])
        for item in items:
            nitpick_ignore.append((category.replace("-", ":"), item))


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

autodoc_default_options = {
    "members": True,
    "undoc-members": True,
    "show-inheritance": True,
    "member-order": "bysource",
}

# -- 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 = []

# Support external links to specific versions of the files in the Github repo
branch = os.environ.get("READTHEDOCS_VERSION")
if branch is None or branch == "latest":
    branch = "main"

REPO = "open-telemetry/opentelemetry-python-contrib/"
scm_raw_web = "https://raw.githubusercontent.com/" + REPO + branch
scm_web = "https://github.com/" + REPO + "blob/" + branch

# Store variables in the epilogue so they are globally available.
rst_epilog = f"""
.. |SCM_WEB| replace:: {scm_web}
.. |SCM_RAW_WEB| replace:: {scm_raw_web}
.. |SCM_BRANCH| replace:: {branch}
"""

# used to have links to repo files
extlinks = {
    "scm_raw_web": (scm_raw_web + "/%s", "scm_raw_web"),
    "scm_web": (scm_web + "/%s", "scm_web"),
}