mirror of
https://github.com/pybricks/pybricks-api.git
synced 2026-09-12 09:37:25 +00:00
126 lines
3.3 KiB
Python
126 lines
3.3 KiB
Python
from os import makedirs, path
|
|
|
|
from docutils import nodes
|
|
from docutils.parsers.rst import Directive
|
|
from sphinx.util.osutil import copyfile
|
|
|
|
# Base feature set.
|
|
FEATURES_SMALL = set()
|
|
|
|
# Medium feature set.
|
|
FEATURES_MEDIUM = FEATURES_SMALL | {
|
|
"pybricks-common-control",
|
|
"pybricks-iodevices",
|
|
"stm32-extra",
|
|
"stm32-float",
|
|
"pybricks-frozen",
|
|
}
|
|
|
|
# Features per hub.
|
|
HUB_FEATURES = {
|
|
"movehub": {"movehub", "ble", "pupdevices"} | FEATURES_SMALL,
|
|
"cityhub": {"cityhub", "ble", "pupdevices"} | FEATURES_MEDIUM,
|
|
"technichub": {"technichub", "gyro", "xbox-controller", "ble", "pupdevices"}
|
|
| FEATURES_MEDIUM,
|
|
"primehub": {
|
|
"primehub",
|
|
"inventorhub",
|
|
"light-matrix",
|
|
"gyro",
|
|
"xbox-controller",
|
|
"ble",
|
|
"ble-extra",
|
|
"pupdevices",
|
|
}
|
|
| FEATURES_MEDIUM,
|
|
"inventorhub": {
|
|
"primehub",
|
|
"inventorhub",
|
|
"light-matrix",
|
|
"gyro",
|
|
"xbox-controller",
|
|
"ble",
|
|
"ble-extra",
|
|
"pupdevices",
|
|
}
|
|
| FEATURES_MEDIUM,
|
|
"essentialhub": {
|
|
"essentialhub",
|
|
"gyro",
|
|
"xbox-controller",
|
|
"ble",
|
|
"ble-extra",
|
|
"pupdevices",
|
|
}
|
|
| FEATURES_MEDIUM,
|
|
"ev3brick": {"ev3devices", "nxtdevices", "image"} | FEATURES_MEDIUM,
|
|
}
|
|
|
|
|
|
class PybricksRequirementsStaticDirective(Directive):
|
|
required_arguments = 0
|
|
optional_arguments = 10
|
|
|
|
def run(self):
|
|
# Copy required resources to static
|
|
# CC BY-SA 4.0 via https://stackoverflow.com/a/63728208
|
|
env = self.state.document.settings.env
|
|
|
|
destdir = path.join(env.app.builder.outdir, "_images")
|
|
if not path.exists(destdir):
|
|
makedirs(destdir)
|
|
|
|
for hub in HUB_FEATURES:
|
|
uri = f"compat_{hub}.png"
|
|
src_uri = path.join(env.app.builder.srcdir, "diagrams", uri)
|
|
build_uri = path.join(env.app.builder.outdir, "_images", uri)
|
|
copyfile(src_uri, build_uri)
|
|
|
|
# Get requirements from sphinx-directive.
|
|
requirements = set(self.arguments)
|
|
|
|
# Cell with image of a hub.
|
|
hub_cell = """
|
|
<th background="{0}_images/compat_{1}.png" class="requirements-table-th requirements-table-th">
|
|
{2}
|
|
</th>
|
|
"""
|
|
|
|
# Determine how far up the tree we are to set correct image path.
|
|
current_document = env.docname
|
|
depth = len(current_document.split("/")) - 1
|
|
depth_path = "../" * depth
|
|
|
|
# Table row with hub images.
|
|
compat_row = "".join(
|
|
[
|
|
hub_cell.format(
|
|
depth_path, hub, "✅" if requirements <= features else "❌"
|
|
)
|
|
for hub, features in HUB_FEATURES.items()
|
|
]
|
|
)
|
|
|
|
# Generate full table.
|
|
html = f"""
|
|
<div class="wy-table-responsive">
|
|
<table class="docutils align-default requirements-table">
|
|
<tbody>
|
|
<tr>
|
|
{compat_row}
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
"""
|
|
|
|
# Return the node.
|
|
node = nodes.raw("", html, format="html")
|
|
return [node]
|
|
|
|
|
|
def setup(app):
|
|
app.add_directive_to_domain(
|
|
"py", "pybricks-requirements-static", PybricksRequirementsStaticDirective
|
|
)
|