mkl_random/docs/source/conf.py at 0c4d814a832c426e4bc2335efdb3a427c14007c9 · IntelPython/mkl_random · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = "mkl_random"
copyright = "2017-2025, Intel Corp."
author = "Intel Corp."
release = "1.4.0dev4"

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = [
    "sphinx.ext.autodoc",
    "sphinx.ext.autosummary",
    "sphinx.ext.coverage",
    "sphinx.ext.extlinks",
    "sphinx.ext.intersphinx",
    "sphinx.ext.githubpages",
    "sphinx.ext.napoleon",
    "sphinx.ext.todo",
    "sphinx.ext.viewcode",
    "sphinxcontrib.programoutput",
    # "sphinxcontrib.googleanalytics",
    "sphinx_design",
]

templates_path = ["_templates"]
exclude_patterns = []


# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = "furo"
html_static_path = ["_static"]

# remove linter flags from rendered docstrings


def remove_linter_flags(app, what, name, obj, options, lines):
    for index, line in enumerate(lines):
        if "# noqa" in line or "# no-cython-lint" in line:
            lines[index] = line.split("#")[0].rstrip()


def setup(app):
    app.connect("autodoc-process-docstring", remove_linter_flags)