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
|
# We want to document both the UNSET singleton, and the UnsetType class, but we
# don't want them to have the same docstring. I couldn't find an easy way to
# do this in sphinx. For now, we patch the UnsetType object when building types
# to override the docstring handling.
try:
import msgspec
class UnsetType:
"""The type of `UNSET`.
See Also
--------
UNSET
"""
msgspec.UnsetType = UnsetType
except ImportError:
pass
project = "msgspec"
copyright = "Jim Crist-Harif"
author = "Jim Crist-Harif"
GITHUB_LOGO = """
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
</svg>
""".strip()
html_theme = "furo"
html_title = ""
templates_path = ["_templates"]
html_static_path = ["_static"]
html_css_files = ["custom.css"]
pygments_style = "default"
_link_color_light = "#024bb0"
_link_color_dark = "#5192d2"
html_theme_options = {
"light_logo": "msgspec-logo-light.svg",
"dark_logo": "msgspec-logo-dark.svg",
"light_css_variables": {
"color-brand-primary": "black",
"color-brand-content": _link_color_light,
"color-foreground-muted": "#808080",
"color-highlight-on-target": "inherit",
"color-highlighted-background": "#ffffcc",
"color-sidebar-link-text": "black",
"color-sidebar-link-text--top-level": "black",
"color-link": _link_color_light,
"color-link--hover": _link_color_light,
"color-link-underline": "transparent",
"color-link-underline--hover": _link_color_light,
},
"dark_css_variables": {
"color-brand-primary": "#ffffff",
"color-brand-content": _link_color_dark,
"color-highlight-on-target": "inherit",
"color-highlighted-background": "#333300",
"color-sidebar-link-text": "#ffffffcc",
"color-sidebar-link-text--top-level": "#ffffffcc",
"color-link": _link_color_dark,
"color-link--hover": _link_color_dark,
"color-link-underline": "transparent",
"color-link-underline--hover": _link_color_dark,
},
"sidebar_hide_name": True,
"footer_icons": [
{
"name": "GitHub",
"url": "https://github.com/jcrist/msgspec",
"html": GITHUB_LOGO,
"class": "",
},
],
}
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
"sphinx.ext.extlinks",
"sphinx.ext.intersphinx",
"sphinx_copybutton",
"sphinx_design",
"IPython.sphinxext.ipython_console_highlighting",
]
intersphinx_mapping = {
"python": ("/usr/share/doc/python3-doc/html", None),
"attrs": ("/usr/share/doc/python-attr-doc/html", None),
}
autodoc_typehints = "none"
napoleon_numpy_docstring = True
napoleon_google_docstring = False
napoleon_use_rtype = False
napoleon_custom_sections = [("Configuration", "params_style")]
default_role = "obj"
extlinks = {
"issue": ("https://github.com/jcrist/msgspec/issues/%s", "Issue #%s"),
"pr": ("https://github.com/jcrist/msgspec/pull/%s", "PR #%s"),
}
copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: "
copybutton_prompt_is_regexp = True
|
