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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
# 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
from __future__ import annotations
import importlib
import importlib.metadata
import inspect
import os
import sys
import warnings
from pathlib import Path
try:
import scikit_build_core
except ModuleNotFoundError:
scikit_build_core = None
ROOT = Path(__file__).parent.parent.resolve()
# Custom extension
sys.path.append(str(ROOT / "docs/ext"))
try:
from scikit_build_core import __version__ as version
except ModuleNotFoundError:
try:
version = importlib.metadata.version("scikit_build_core")
except ModuleNotFoundError:
msg = (
"Package should be installed to produce documentation! "
"Assuming a modern git archive was used for version discovery."
)
warnings.warn(msg, stacklevel=1)
from setuptools_scm import get_version
version = get_version(root=ROOT, fallback_root=ROOT)
# Filter git details from version
release = version.split("+")[0]
# -- Project information -----------------------------------------------------
project = "scikit-build-core"
copyright = "2022, The Scikit-Build admins"
author = "Henry Schreiner"
# -- 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 = [
"conftabs",
"myst_parser",
"sphinx-jsonschema",
"sphinx.ext.autodoc",
"sphinx.ext.intersphinx",
"sphinx.ext.linkcode",
"sphinx.ext.mathjax",
"sphinx.ext.napoleon",
"sphinx_autodoc_typehints",
"sphinx_copybutton",
"sphinx_inline_tabs",
"sphinx_tippy",
"sphinxcontrib.programoutput",
]
# Add any paths that contain templates here, relative to this directory.
templates_path = []
source_suffix = [".rst", ".md"]
# 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",
"**.ipynb_checkpoints",
"Thumbs.db",
".DS_Store",
".env",
"**.venv",
"examples/downstream",
]
intersphinx_mapping = {
"cmake": ("https://cmake.org/cmake/help/latest/", None),
"python": ("https://docs.python.org/3", None),
"packaging": ("https://packaging.pypa.io/en/stable", None),
"setuptools": ("https://setuptools.pypa.io/en/latest", None),
"hatchling": ("https://hatch.pypa.io/latest", None),
}
tippy_rtd_urls = [
val[0]
for key, val in intersphinx_mapping.items()
# Only works with RTD hosted intersphinx
if key not in ("hatchling", "python", "cmake")
]
nitpick_ignore = [
("py:class", "setuptools.dist.Distribution"),
("py:class", "T"),
("py:class", "scikit_build_core.settings.sources.T"),
("py:class", "scikit_build_core._vendor.pyproject_metadata.StandardMetadata"),
]
linkcheck_anchors_ignore = [
# This seems to be broken on GitHub readmes
"default-versioning-scheme",
"git-archives",
]
linkcheck_ignore = [
# Rate limited
r"https://github.com/?.*",
]
# -- 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 = "furo"
# -- Extension configuration -------------------------------------------------
myst_enable_extensions = [
"colon_fence",
"substitution",
"deflist",
]
myst_substitutions = {
"version": version,
}
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section)
man_pages = [
(
"man",
project,
"A Python module build backend for CMake",
[author],
7,
)
]
commit = os.environ.get("READTHEDOCS_GIT_COMMIT_HASH", "main")
code_url = "https://github.com/scikit-build/scikit-build-core/blob"
def linkcode_resolve(domain: str, info: dict[str, str]) -> str | None:
if scikit_build_core is None:
return None
if domain != "py":
return None
mod = importlib.import_module(info["module"])
if "." in info["fullname"]:
objname, attrname = info["fullname"].split(".")
obj = getattr(mod, objname)
try:
# object is a method of a class
obj = getattr(obj, attrname)
except AttributeError:
# object is an attribute of a class
return None
else:
obj = getattr(mod, info["fullname"])
try:
file = Path(inspect.getsourcefile(obj))
lines = inspect.getsourcelines(obj)
except TypeError:
# e.g. object is a typing.Union
return None
try:
mod = Path(inspect.getsourcefile(scikit_build_core)).parent
file = file.relative_to(mod)
except ValueError:
return None
start, end = lines[1], lines[1] + len(lines[0]) - 1
return f"{code_url}/{commit}/src/scikit_build_core/{file}#L{start}-L{end}"
|
