conf.py

# SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0

# 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 os
import sys
from pathlib import Path

sys.path.insert(0, str((Path(__file__).parents[3] / "cuda_python" / "docs" / "exts").absolute()))


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

project = "cuda.core"
copyright = "2024, NVIDIA"
author = "NVIDIA"

# The full version, including alpha/beta/rc tags
release = os.environ["SPHINX_CUDA_CORE_VER"]


# -- 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.autosummary",
    "sphinx.ext.napoleon",
    "sphinx.ext.intersphinx",
    "myst_nb",
    "sphinx_copybutton",
    "sphinx_toolbox.more_autodoc.autoprotocol",
    "release_toc",
    "release_date",
    "enum_documenter",
]

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

# Include object entries (methods, attributes, etc.) in the table of contents
# This enables the "On This Page" sidebar to show class methods and properties
# Requires Sphinx 5.1+
toc_object_entries = True
toc_object_entries_show_parents = "domain"

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

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
html_baseurl = "docs"
html_theme = "nvidia_sphinx_theme"
html_theme_options = {
    "switcher": {
        "json_url": "https://nvidia.github.io/cuda-python/cuda-core/nv-versions.json",
        "version_match": release,
    },
    # Add light/dark mode and documentation version switcher
    "navbar_center": [
        "version-switcher",
        "navbar-nav",
    ],
    # Use custom secondary sidebar that includes autodoc entries
    "secondary_sidebar_items": ["page-toc"],
    # Show more TOC levels by default
    "show_toc_level": 3,
}
if os.environ.get("CI"):
    if int(os.environ.get("BUILD_PREVIEW", 0)):
        PR_NUMBER = f"{os.environ['PR_NUMBER']}"
        PR_TEXT = f'<a href="https://github.com/NVIDIA/cuda-python/pull/{PR_NUMBER}">PR {PR_NUMBER}</a>'
        html_theme_options["announcement"] = f"<em>Warning</em>: This documentation is only a preview for {PR_TEXT}!"
    elif int(os.environ.get("BUILD_LATEST", 0)):
        html_theme_options["announcement"] = (
            "<em>Warning</em>: This documentation is built from the development branch!"
        )

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

# skip cmdline prompts
copybutton_exclude = ".linenos, .gp"

intersphinx_mapping = {
    "python": ("https://docs.python.org/3/", None),
    "numpy": ("https://numpy.org/doc/stable/", None),
    "cuda.bindings": ("https://nvidia.github.io/cuda-python/cuda-bindings/latest", None),
}

napoleon_google_docstring = False
napoleon_numpy_docstring = True

section_titles = ["Returns"]


def autodoc_process_docstring(app, what, name, obj, options, lines):
    if name.startswith("cuda.core._system.System"):
        name = name.replace("._system.System", ".system")
        # patch the docstring (in lines) *in-place*. Should docstrings include section titles other than "Returns",
        # this will need to be modified to handle them.
        while lines:
            lines.pop()
        attr = name.split(".")[-1]
        from cuda.core._system import System

        original_lines = getattr(System, attr).__doc__.split("\n")
        new_lines = []
        new_lines.append(f".. py:data:: {name}")
        new_lines.append("")
        for line in original_lines:
            title = line.strip()
            if title in section_titles:
                new_lines.append(line.replace(title, f".. rubric:: {title}"))
            elif line.strip() == "-" * len(title):
                new_lines.append(" " * len(title))
            else:
                new_lines.append(line)
        lines.extend(new_lines)


def skip_member(app, what, name, obj, skip, options):
    # skip undocumented attributes for modules documented
    # with cyclass.rst template where attributes
    # are assumed to be properties (because cythonized
    # properties are not recognized as such by autodoc)
    excluded_dirs = [
        "cuda.core._layout",
        "cuda.core._memoryview",
    ]
    if what == "attribute" and getattr(obj, "__doc__", None) is None:
        obj_module = getattr(getattr(obj, "__objclass__", None), "__module__", None)
        if obj_module in excluded_dirs:
            print(f"Skipping undocumented attribute {name} in {obj_module}")
            return True
    return None


def setup(app):
    app.connect("autodoc-process-docstring", autodoc_process_docstring)
    app.connect("autodoc-skip-member", skip_member)