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
|
# From https://github.com/pradyunsg/sphinx-inline-tabs
# Copyright (c) 2020 Pradyun Gedam <mail@pradyunsg.me>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.
#
# stdlib
import shutil
from typing import Optional
# 3rd party
import sphinx_inline_tabs
from docutils import nodes
from domdf_python_tools.paths import PathPlus
from sphinx.application import Sphinx
from sphinx.errors import NoUri
from sphinx.writers.latex import LaTeXTranslator
from sphinx_inline_tabs._impl import TabContainer, TabDirective, TabHtmlTransform, _TabInput, _TabLabel
def copy_asset_files(app: Sphinx, exception: Optional[Exception] = None) -> None:
"""
Copy asset files to the output.
:param app: The Sphinx application.
:param exception: Any exception which occurred and caused Sphinx to abort.
"""
if exception: # pragma: no cover
return
if app.builder.format.lower() != "html":
return
source_dir = PathPlus(sphinx_inline_tabs.__file__).parent / "static"
css_static_dir = PathPlus(app.builder.outdir) / "_static" / "css"
css_static_dir.maybe_make(parents=True)
shutil.copy2(source_dir / "tabs.css", css_static_dir / "inline-tabs.css")
js_static_dir = PathPlus(app.builder.outdir) / "_static" / "js"
js_static_dir.maybe_make(parents=True)
shutil.copy2(source_dir / "tabs.js", js_static_dir / "inline-tabs.js")
def handle_missing_xref(app: Sphinx, env, node: nodes.Node, contnode: nodes.Node) -> None:
# Ignore missing reference warnings for the wheel_filename module
if node.get("reftarget", '') == "dist_meta.metadata_mapping._T":
raise NoUri
def visit_tab_container(translator: LaTeXTranslator, node: _TabLabel):
# translator.visit_label
translator.body.append("\n\\begin{tcolorbox}[left=2pt,right=2pt]\n")
translator.body.append(f"\n\\textbf{{{node.children[0].children[0]}}}\n")
def depart_tab_container(translator: LaTeXTranslator, node: _TabLabel):
translator.body.append("\n\\end{tcolorbox}")
def setup(app: Sphinx):
# We do imports from Sphinx, after validating the Sphinx version
app.add_directive("inline-tab", TabDirective)
app.add_post_transform(TabHtmlTransform)
app.add_node(TabContainer, latex=(visit_tab_container, depart_tab_container))
app.add_node(_TabInput, html=(_TabInput.visit, _TabInput.depart))
app.add_node(_TabLabel, html=(_TabLabel.visit, _TabLabel.depart))
# Include our static assets
app.connect("build-finished", copy_asset_files)
app.add_js_file("js/inline-tabs.js")
app.add_css_file("css/inline-tabs.css")
app.connect("missing-reference", handle_missing_xref, priority=950)
return {
"parallel_read_safe": True,
"parallel_write_safe": True,
}
|
