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
|
# noqa: D100
from __future__ import annotations
from typing import TYPE_CHECKING
from sphinx.domains.python import PythonDomain
from pyproject_api import __version__
if TYPE_CHECKING:
from docutils.nodes import Element
from sphinx.application import Sphinx
from sphinx.builders import Builder
from sphinx.environment import BuildEnvironment
project = name = "pyproject_api"
company = "tox-dev"
project_copyright = f"{company}"
version, release = __version__, __version__.split("+")[0]
extensions = [
"sphinx.ext.autosectionlabel",
"sphinx.ext.extlinks",
"sphinx.ext.autodoc",
"sphinx_autodoc_typehints",
"sphinx.ext.viewcode",
"sphinx.ext.intersphinx",
]
master_doc, source_suffix = "index", ".rst"
html_theme = "furo"
html_title, html_last_updated_fmt = "pyproject-api docs", "%Y-%m-%dT%H:%M:%S"
pygments_style, pygments_dark_style = "sphinx", "monokai"
autoclass_content, autodoc_typehints = "both", "none"
autodoc_default_options = {"members": True, "member-order": "bysource", "undoc-members": True, "show-inheritance": True}
inheritance_alias = {}
extlinks = {
"issue": ("https://github.com/tox-dev/pyproject-api/issues/%s", "#%s"),
"pull": ("https://github.com/tox-dev/pyproject-api/pull/%s", "PR #%s"),
"user": ("https://github.com/%s", "@%s"),
}
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"packaging": ("https://packaging.pypa.io/en/latest", None),
}
nitpicky = True
nitpick_ignore = []
def setup(app: Sphinx) -> None: # noqa: D103
class PatchedPythonDomain(PythonDomain):
def resolve_xref( # noqa: PLR0913,PLR0917
self,
env: BuildEnvironment,
fromdocname: str,
builder: Builder,
type: str, # noqa: A002
target: str,
node: resolve_xref,
contnode: Element,
) -> Element:
# fixup some wrongly resolved mappings
mapping = {
"pathlib._local.Path": "pathlib.Path",
}
if target in mapping:
target = node["reftarget"] = mapping[target]
return super().resolve_xref(env, fromdocname, builder, type, target, node, contnode)
app.add_domain(PatchedPythonDomain, override=True)
|
