-
Notifications
You must be signed in to change notification settings - Fork 297
/
__init__.py
325 lines (260 loc) · 10.4 KB
/
__init__.py
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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
"""A clean customisable Sphinx documentation theme."""
__version__ = "2021.07.05.dev39"
import logging
import os
import textwrap
from functools import lru_cache
from pathlib import Path
from typing import Any, Dict, Optional
import sphinx.application
from bs4 import BeautifulSoup
from pygments.formatters import HtmlFormatter
from pygments.style import Style
from pygments.token import Text
from sphinx.builders.html import StandaloneHTMLBuilder
from sphinx.highlighting import PygmentsBridge
from .navigation import get_navigation_tree
THEME_PATH = (Path(__file__).parent / "theme" / "furo").resolve()
logger = logging.getLogger(__name__)
# GLOBAL STATE
_KNOWN_STYLES_IN_USE: Dict[str, Optional[Style]] = {
"light": None,
"dark": None,
}
@lru_cache(maxsize=None)
def has_exactly_one_list_item(toc: str) -> bool:
"""Check if the toc has exactly one list item."""
assert toc
soup = BeautifulSoup(toc, "html.parser")
if len(soup.find_all("li")) == 1:
return True
return False
def wrap_elements_that_can_get_too_wide(content: str) -> str:
"""Wrap the elements that could get too wide, with a div to allow controlling width.
- <table>
- [class=math]
"""
soup = BeautifulSoup(content, "html.parser")
for table in soup.find_all("table"):
table_wrapper = soup.new_tag("div", attrs={"class": "table-wrapper"})
table.replace_with(table_wrapper)
table_wrapper.append(table)
for math in soup.find_all("div", class_="math"):
wrapper = soup.new_tag("div", attrs={"class": "math-wrapper"})
math.replace_with(wrapper)
wrapper.append(math)
return str(soup)
def get_pygments_style_colors(
style: Style, *, fallbacks: Dict[str, str]
) -> Dict[str, str]:
"""Get background/foreground colors for given pygments style."""
background = style.background_color
text_colors = style.style_for_token(Text)
foreground = text_colors["color"]
if not background:
background = fallbacks["background"]
if not foreground:
foreground = fallbacks["foreground"]
else:
foreground = f"#{foreground}"
return {"background": background, "foreground": foreground}
@lru_cache(maxsize=2)
def get_colors_for_codeblocks(
highlighter: PygmentsBridge, *, fg: str, bg: str
) -> Dict[str, str]:
"""Get background/foreground colors for given pygments style."""
return get_pygments_style_colors(
highlighter.formatter_args["style"],
fallbacks={
"foreground": fg,
"background": bg,
},
)
def _compute_navigation_tree(context: Dict[str, Any]) -> str:
# The navigation tree, generated from the sphinx-provided ToC tree.
if "toctree" in context:
toctree = context["toctree"]
toctree_html = toctree(
collapse=False,
titles_only=True,
maxdepth=-1,
includehidden=True,
)
else:
toctree_html = ""
return get_navigation_tree(toctree_html)
def _compute_hide_toc(context: Dict[str, Any]) -> bool:
# Should the table of contents be hidden?
file_meta = context.get("meta", None) or {}
if "hide-toc" in file_meta:
return True
elif "toc" not in context:
return True
elif not context["toc"]:
return True
return has_exactly_one_list_item(context["toc"])
def _html_page_context(
app: sphinx.application.Sphinx,
pagename: str,
templatename: str,
context: Dict[str, Any],
doctree: Any,
) -> None:
if app.config.html_theme != "furo":
return
# Basic constants
context["furo_version"] = __version__
# Values computed from page-level context.
context["furo_navigation_tree"] = _compute_navigation_tree(context)
context["furo_hide_toc"] = _compute_hide_toc(context)
# Inject information about styles
context["furo_pygments"] = {
"light": get_pygments_style_colors(
_KNOWN_STYLES_IN_USE["light"],
fallbacks=dict(
foreground="black",
background="white",
),
),
"dark": get_pygments_style_colors(
_KNOWN_STYLES_IN_USE["dark"],
fallbacks=dict(
foreground="white",
background="black",
),
),
}
# Patch the content
if "body" in context:
context["body"] = wrap_elements_that_can_get_too_wide(context["body"])
def _builder_inited(app: sphinx.application.Sphinx) -> None:
if app.config.html_theme != "furo":
return
# Our `main.js` file needs to be loaded as soon as possible.
app.add_js_file("scripts/main.js", priority=200)
# 500 is the default priority for extensions, we want this after this.
app.add_css_file("styles/furo-extensions.css", priority=600)
builder: StandaloneHTMLBuilder = app.builder
assert builder, "what?"
assert (
builder.highlighter is not None
), "there should be a default style known to Sphinx"
assert (
builder.dark_highlighter is None
), "this shouldn't be a dark style known to Sphinx"
update_known_styles_state(app)
def update_known_styles_state(app: sphinx.application.Sphinx) -> None:
"""Update a global store of known styles of this application."""
global _KNOWN_STYLES_IN_USE
_KNOWN_STYLES_IN_USE = {
"light": _get_light_style(app),
"dark": _get_dark_style(app),
}
def _get_light_style(app: sphinx.application.Sphinx) -> Style:
return app.builder.highlighter.formatter_args["style"]
def _get_dark_style(app: sphinx.application.Sphinx) -> Style:
# number_of_hours_spent_figuring_this_out = 7
#
# Hello human in the future! This next block of code needs a bit of a story, and
# if you're going to touch it, remember to update the number above (or remove this
# comment entirely).
#
# Hopefully, you know that Sphinx allows extensions and themes to add configuration
# values via `app.add_config_value`. This usually lets users set those values from
# `conf.py` while allowing the extension to read from it and utilise that information.
# As any reasonable person who's written a Sphinx extension before, you would
# expect the following to work:
#
# dark_style = app.config.pygments_dark_style
#
# Turns out, no. How dare you expect things to just work!? That stuff just returns
# the default value provided when calling `app.add_config_value`. Yes, even if you
# set it in `conf.py`. Why? Good question. :)
#
# The logic in Sphinx literally looks it up in the same mapping as what was
# manipulated by `add_config_value`, and there's no other spot where that value
# gets manipulated. I spent a bunch of time debugging how that class works, and...
# yea, I can't figure it out. There's multiple mappings floating around and bunch
# of manipulation being done for all kinds of things.
#
# The only place on the config object where I was able to find the user-provided
# value from `conf.py` is a private variable `self._raw_config`. Those values are
# supposed to get added to self.__dict__[...], and generally be accessible through
# the object's custom `__getattr__`.
#
# Anyway, after giving up on figuring out how to file a PR to fix this upstream, I
# started looking for hacky ways to get this without reaching into private
# variables. That quest led to a very simple conclusion: no, you can't do that.
#
# So, here we are: with the only option being to reach into the guts of the beast,
# and pull out the specific thing that's needed. This is obviously fragile though,
# so this is written with the assumption that any changes to Sphinx's config
# object's internals would correspond to the originally expected behaviour working.
# This is so that when any of Sphinx's internals change, this logic would basically
# fall back to the original behaviour and also print a warning, so that hopefully
# someone will report this. Maybe it'll all be fixed, and I can remove this whole
# hack and this giant comment.
# HACK: begins here
dark_style = None
try:
if (
hasattr(app.config, "_raw_config")
and isinstance(app.config._raw_config, dict)
and "pygments_dark_style" in app.config._raw_config
):
dark_style = app.config._raw_config["pygments_dark_style"]
except (AttributeError, KeyError) as e:
logger.warn(
(
"Furo could not determine the value of `pygments_dark_style`. "
"Falling back to using the value provided by Sphinx.\n"
"Caused by %s"
),
e,
)
if dark_style is None:
dark_style = app.config.pygments_dark_style
return PygmentsBridge("html", dark_style).formatter_args["style"]
def get_pygments_stylesheet() -> str:
"""Generate the theme-specific pygments.css.
There is no way to tell Sphinx how the theme handles dark mode; at this time.
"""
light_formatter = HtmlFormatter(style=_KNOWN_STYLES_IN_USE["light"])
dark_formatter = HtmlFormatter(style=_KNOWN_STYLES_IN_USE["dark"])
light = light_formatter.get_style_defs(".highlight")
dark_one = dark_formatter.get_style_defs('body[data-theme="dark"] .highlight')
dark_two = dark_formatter.get_style_defs(
'body:not([data-theme="light"]) .highlight'
)
return textwrap.dedent(
f"""
{light}
{dark_one}
@media (prefers-color-scheme: dark) {{
{dark_two}
}}
"""
)
# Yup, we overwrite the default pygments.css file, because it can't possibly respect
# the needs of this theme.
def _overwrite_pygments_css(
app: sphinx.application.Sphinx,
exception: Optional[Exception],
) -> None:
with open(os.path.join(app.builder.outdir, "_static", "pygments.css"), "w") as f:
f.write(get_pygments_stylesheet())
def setup(app: sphinx.application.Sphinx) -> Dict[str, Any]:
"""Entry point for sphinx theming."""
app.require_sphinx("3.0")
app.add_config_value(
"pygments_dark_style", default="native", rebuild="env", types=[str]
)
app.add_html_theme("furo", str(THEME_PATH))
app.connect("html-page-context", _html_page_context)
app.connect("builder-inited", _builder_inited)
app.connect("build-finished", _overwrite_pygments_css)
return {
"parallel_read_safe": True,
"parallel_write_safe": True,
"version": __version__,
}