diff --git a/doc/Makefile b/doc/Makefile index 84549d4..b180739 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -16,8 +16,8 @@ help: .PHONY: help Makefile diagrams: - @$(MAKE) -C "$(SOURCEDIR)"/diagram_source clean - @$(MAKE) -C "$(SOURCEDIR)"/diagram_source + @$(MAKE) -C "$(SOURCEDIR)"/diagrams_source clean + @$(MAKE) -C "$(SOURCEDIR)"/diagrams_source # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). diff --git a/doc/common/extensions/requirements-static.py b/doc/common/extensions/requirements-static.py index 046f9a5..755e0d4 100644 --- a/doc/common/extensions/requirements-static.py +++ b/doc/common/extensions/requirements-static.py @@ -47,20 +47,19 @@ class PybricksRequirementsStaticDirective(Directive): makedirs(destdir) for hub in HUB_FEATURES: - for compat in ("true", "false"): - uri = "compat_{0}_{1}.png".format(hub, compat) - 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) + uri = "compat_{0}.png".format(hub) + 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 = """ -
- -
+ + {2} + """ # Determine how far up the tree we are to set correct image path. @@ -72,7 +71,7 @@ class PybricksRequirementsStaticDirective(Directive): compat_row = "".join( [ hub_cell.format( - depth_path, hub, "true" if requirements <= features else "false" + depth_path, hub, "✅" if requirements <= features else "❌" ) for hub, features in HUB_FEATURES.items() ] @@ -81,7 +80,7 @@ class PybricksRequirementsStaticDirective(Directive): # Generate full table. html = """
- +
{0} diff --git a/doc/common/extensions/requirements.css b/doc/common/extensions/requirements.css index e295b4f..0ee70d2 100644 --- a/doc/common/extensions/requirements.css +++ b/doc/common/extensions/requirements.css @@ -42,3 +42,19 @@ SOFTWARE. */ margin-bottom: 0px; } +.requirements-table { + width: 100%; +} + +.requirements-table-th { + background-size:contain; + background-repeat: no-repeat; + text-align: right; + padding: 6px !important; + } + +.requirements-table-th:after { + content: ''; + display: block; + margin-top: 80%; + } diff --git a/doc/main/diagrams/compat_cityhub.png b/doc/main/diagrams/compat_cityhub.png new file mode 100644 index 0000000..e92655f Binary files /dev/null and b/doc/main/diagrams/compat_cityhub.png differ diff --git a/doc/main/diagrams/compat_cityhub_false.png b/doc/main/diagrams/compat_cityhub_false.png deleted file mode 100644 index 5a467b0..0000000 Binary files a/doc/main/diagrams/compat_cityhub_false.png and /dev/null differ diff --git a/doc/main/diagrams/compat_cityhub_true.png b/doc/main/diagrams/compat_cityhub_true.png deleted file mode 100644 index d05e8bf..0000000 Binary files a/doc/main/diagrams/compat_cityhub_true.png and /dev/null differ diff --git a/doc/main/diagrams/compat_essentialhub.png b/doc/main/diagrams/compat_essentialhub.png new file mode 100644 index 0000000..ddf9a4a Binary files /dev/null and b/doc/main/diagrams/compat_essentialhub.png differ diff --git a/doc/main/diagrams/compat_essentialhub_false.png b/doc/main/diagrams/compat_essentialhub_false.png deleted file mode 100644 index 6909f5d..0000000 Binary files a/doc/main/diagrams/compat_essentialhub_false.png and /dev/null differ diff --git a/doc/main/diagrams/compat_essentialhub_true.png b/doc/main/diagrams/compat_essentialhub_true.png deleted file mode 100644 index 3d07239..0000000 Binary files a/doc/main/diagrams/compat_essentialhub_true.png and /dev/null differ diff --git a/doc/main/diagrams/compat_inventorhub.png b/doc/main/diagrams/compat_inventorhub.png new file mode 100644 index 0000000..832870f Binary files /dev/null and b/doc/main/diagrams/compat_inventorhub.png differ diff --git a/doc/main/diagrams/compat_inventorhub_false.png b/doc/main/diagrams/compat_inventorhub_false.png deleted file mode 100644 index 0fb2597..0000000 Binary files a/doc/main/diagrams/compat_inventorhub_false.png and /dev/null differ diff --git a/doc/main/diagrams/compat_inventorhub_true.png b/doc/main/diagrams/compat_inventorhub_true.png deleted file mode 100644 index bbc268d..0000000 Binary files a/doc/main/diagrams/compat_inventorhub_true.png and /dev/null differ diff --git a/doc/main/diagrams/compat_movehub.png b/doc/main/diagrams/compat_movehub.png new file mode 100644 index 0000000..109e5ed Binary files /dev/null and b/doc/main/diagrams/compat_movehub.png differ diff --git a/doc/main/diagrams/compat_movehub_false.png b/doc/main/diagrams/compat_movehub_false.png deleted file mode 100644 index 9944939..0000000 Binary files a/doc/main/diagrams/compat_movehub_false.png and /dev/null differ diff --git a/doc/main/diagrams/compat_movehub_true.png b/doc/main/diagrams/compat_movehub_true.png deleted file mode 100644 index e7b61e3..0000000 Binary files a/doc/main/diagrams/compat_movehub_true.png and /dev/null differ diff --git a/doc/main/diagrams/compat_primehub.png b/doc/main/diagrams/compat_primehub.png new file mode 100644 index 0000000..5a1a304 Binary files /dev/null and b/doc/main/diagrams/compat_primehub.png differ diff --git a/doc/main/diagrams/compat_primehub_false.png b/doc/main/diagrams/compat_primehub_false.png deleted file mode 100644 index 7d20646..0000000 Binary files a/doc/main/diagrams/compat_primehub_false.png and /dev/null differ diff --git a/doc/main/diagrams/compat_primehub_true.png b/doc/main/diagrams/compat_primehub_true.png deleted file mode 100644 index 0f1b71c..0000000 Binary files a/doc/main/diagrams/compat_primehub_true.png and /dev/null differ diff --git a/doc/main/diagrams/compat_technichub.png b/doc/main/diagrams/compat_technichub.png new file mode 100644 index 0000000..9bd8e7a Binary files /dev/null and b/doc/main/diagrams/compat_technichub.png differ diff --git a/doc/main/diagrams/compat_technichub_false.png b/doc/main/diagrams/compat_technichub_false.png deleted file mode 100644 index b57b149..0000000 Binary files a/doc/main/diagrams/compat_technichub_false.png and /dev/null differ diff --git a/doc/main/diagrams/compat_technichub_true.png b/doc/main/diagrams/compat_technichub_true.png deleted file mode 100644 index 8df19e8..0000000 Binary files a/doc/main/diagrams/compat_technichub_true.png and /dev/null differ diff --git a/doc/main/diagrams_source/compat_cityhub_true.svg b/doc/main/diagrams_source/compat_cityhub.svg similarity index 82% rename from doc/main/diagrams_source/compat_cityhub_true.svg rename to doc/main/diagrams_source/compat_cityhub.svg index 38c6927..1a3a099 100644 --- a/doc/main/diagrams_source/compat_cityhub_true.svg +++ b/doc/main/diagrams_source/compat_cityhub.svg @@ -8,7 +8,7 @@ version="1.1" id="svg887" inkscape:version="1.1.2 (0a00cf5339, 2022-02-04)" - sodipodi:docname="compat_cityhub_true.svg" + sodipodi:docname="compat_cityhub.svg" xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" xmlns:xlink="http://www.w3.org/1999/xlink" @@ -40,15 +40,15 @@ inkscape:pageshadow="2" inkscape:zoom="3.3219805" inkscape:cx="34.617903" - inkscape:cy="95.726028" + inkscape:cy="95.575516" inkscape:document-units="px" inkscape:current-layer="layer1" showgrid="false" units="px" - inkscape:window-width="1920" - inkscape:window-height="1163" - inkscape:window-x="1920" - inkscape:window-y="0" + inkscape:window-width="1856" + inkscape:window-height="1136" + inkscape:window-x="64" + inkscape:window-y="27" inkscape:window-maximized="1" inkscape:snap-global="false" inkscape:pagecheckerboard="0" /> @@ -75,10 +75,5 @@ y="265.09711" width="23.382999" height="26.799999" /> - diff --git a/doc/main/diagrams_source/compat_cityhub_false.svg b/doc/main/diagrams_source/compat_cityhub_false.svg deleted file mode 100644 index 878d7e0..0000000 --- a/doc/main/diagrams_source/compat_cityhub_false.svg +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - diff --git a/doc/main/diagrams_source/compat_essentialhub_true.svg b/doc/main/diagrams_source/compat_essentialhub.svg similarity index 83% rename from doc/main/diagrams_source/compat_essentialhub_true.svg rename to doc/main/diagrams_source/compat_essentialhub.svg index 822791b..ce8bc28 100644 --- a/doc/main/diagrams_source/compat_essentialhub_true.svg +++ b/doc/main/diagrams_source/compat_essentialhub.svg @@ -8,7 +8,7 @@ version="1.1" id="svg887" inkscape:version="1.1.2 (0a00cf5339, 2022-02-04)" - sodipodi:docname="compat_essentialhub_true.svg" + sodipodi:docname="compat_essentialhub.svg" xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" xmlns:xlink="http://www.w3.org/1999/xlink" @@ -38,9 +38,9 @@ borderopacity="1.0" inkscape:pageopacity="1" inkscape:pageshadow="2" - inkscape:zoom="2.3960249" - inkscape:cx="-130.63303" - inkscape:cy="93.696856" + inkscape:zoom="3.4759103" + inkscape:cx="134.0656" + inkscape:cy="60.84737" inkscape:document-units="px" inkscape:current-layer="layer1" showgrid="false" @@ -75,10 +75,5 @@ y="267.43524" width="25.393" height="22.579" /> - diff --git a/doc/main/diagrams_source/compat_essentialhub_false.svg b/doc/main/diagrams_source/compat_essentialhub_false.svg deleted file mode 100644 index a51db0d..0000000 --- a/doc/main/diagrams_source/compat_essentialhub_false.svg +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - diff --git a/doc/main/diagrams_source/compat_inventorhub_true.svg b/doc/main/diagrams_source/compat_inventorhub.svg similarity index 83% rename from doc/main/diagrams_source/compat_inventorhub_true.svg rename to doc/main/diagrams_source/compat_inventorhub.svg index 34348aa..257c455 100644 --- a/doc/main/diagrams_source/compat_inventorhub_true.svg +++ b/doc/main/diagrams_source/compat_inventorhub.svg @@ -8,7 +8,7 @@ version="1.1" id="svg887" inkscape:version="1.1.2 (0a00cf5339, 2022-02-04)" - sodipodi:docname="compat_inventorhub_true.svg" + sodipodi:docname="compat_inventorhub.svg" xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" xmlns:xlink="http://www.w3.org/1999/xlink" @@ -38,9 +38,9 @@ borderopacity="1.0" inkscape:pageopacity="1" inkscape:pageshadow="2" - inkscape:zoom="3.959798" - inkscape:cx="30.052038" - inkscape:cy="63.260803" + inkscape:zoom="2.6570037" + inkscape:cx="57.583661" + inkscape:cy="87.504583" inkscape:document-units="px" inkscape:current-layer="layer1" showgrid="false" @@ -75,10 +75,5 @@ y="262.86874" width="34.237" height="31.087999" /> - diff --git a/doc/main/diagrams_source/compat_inventorhub_false.svg b/doc/main/diagrams_source/compat_inventorhub_false.svg deleted file mode 100644 index 721f7c5..0000000 --- a/doc/main/diagrams_source/compat_inventorhub_false.svg +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - diff --git a/doc/main/diagrams_source/compat_movehub_true.svg b/doc/main/diagrams_source/compat_movehub.svg similarity index 84% rename from doc/main/diagrams_source/compat_movehub_true.svg rename to doc/main/diagrams_source/compat_movehub.svg index 2431b1b..ea2d530 100644 --- a/doc/main/diagrams_source/compat_movehub_true.svg +++ b/doc/main/diagrams_source/compat_movehub.svg @@ -8,7 +8,7 @@ version="1.1" id="svg887" inkscape:version="1.1.2 (0a00cf5339, 2022-02-04)" - sodipodi:docname="compat_movehub_true.svg" + sodipodi:docname="compat_movehub.svg" xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" xmlns:xlink="http://www.w3.org/1999/xlink" @@ -38,9 +38,9 @@ borderopacity="1.0" inkscape:pageopacity="1" inkscape:pageshadow="2" - inkscape:zoom="3.959798" - inkscape:cx="-61.114229" - inkscape:cy="79.170705" + inkscape:zoom="1.4539184" + inkscape:cx="101.79388" + inkscape:cy="158.5371" inkscape:document-units="px" inkscape:current-layer="layer1" showgrid="false" @@ -75,10 +75,5 @@ y="261.79425" width="38.50182" height="34.867249" /> - diff --git a/doc/main/diagrams_source/compat_movehub_false.svg b/doc/main/diagrams_source/compat_movehub_false.svg deleted file mode 100644 index 2984be2..0000000 --- a/doc/main/diagrams_source/compat_movehub_false.svg +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - diff --git a/doc/main/diagrams_source/compat_primehub_true.svg b/doc/main/diagrams_source/compat_primehub.svg similarity index 84% rename from doc/main/diagrams_source/compat_primehub_true.svg rename to doc/main/diagrams_source/compat_primehub.svg index d8ea30a..a8add9e 100644 --- a/doc/main/diagrams_source/compat_primehub_true.svg +++ b/doc/main/diagrams_source/compat_primehub.svg @@ -8,7 +8,7 @@ version="1.1" id="svg887" inkscape:version="1.1.2 (0a00cf5339, 2022-02-04)" - sodipodi:docname="compat_primehub_true.svg" + sodipodi:docname="compat_primehub.svg" xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" xmlns:xlink="http://www.w3.org/1999/xlink" @@ -38,9 +38,9 @@ borderopacity="1.0" inkscape:pageopacity="1" inkscape:pageshadow="2" - inkscape:zoom="3.959798" - inkscape:cx="-15.152288" - inkscape:cy="104.67706" + inkscape:zoom="2.5665087" + inkscape:cx="-39.742706" + inkscape:cy="115.13696" inkscape:document-units="px" inkscape:current-layer="layer1" showgrid="false" @@ -75,10 +75,5 @@ y="263.1333" width="34.237" height="31.087999" /> - diff --git a/doc/main/diagrams_source/compat_primehub_false.svg b/doc/main/diagrams_source/compat_primehub_false.svg deleted file mode 100644 index 16bafa9..0000000 --- a/doc/main/diagrams_source/compat_primehub_false.svg +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - diff --git a/doc/main/diagrams_source/compat_technichub_true.svg b/doc/main/diagrams_source/compat_technichub.svg similarity index 84% rename from doc/main/diagrams_source/compat_technichub_true.svg rename to doc/main/diagrams_source/compat_technichub.svg index b4c4f81..1b4ff06 100644 --- a/doc/main/diagrams_source/compat_technichub_true.svg +++ b/doc/main/diagrams_source/compat_technichub.svg @@ -8,7 +8,7 @@ version="1.1" id="svg887" inkscape:version="1.1.2 (0a00cf5339, 2022-02-04)" - sodipodi:docname="compat_technichub_true.svg" + sodipodi:docname="compat_technichub.svg" xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" xmlns:xlink="http://www.w3.org/1999/xlink" @@ -38,9 +38,9 @@ borderopacity="1.0" inkscape:pageopacity="1" inkscape:pageshadow="2" - inkscape:zoom="3.959798" - inkscape:cx="51.517779" - inkscape:cy="94.82807" + inkscape:zoom="1.8594069" + inkscape:cx="-63.461097" + inkscape:cy="62.116582" inkscape:document-units="px" inkscape:current-layer="layer1" showgrid="false" @@ -75,10 +75,5 @@ y="263.52396" width="35.710999" height="30.552" /> - diff --git a/doc/main/diagrams_source/compat_technichub_false.svg b/doc/main/diagrams_source/compat_technichub_false.svg deleted file mode 100644 index dd5d07a..0000000 --- a/doc/main/diagrams_source/compat_technichub_false.svg +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - -