Merge pull request adafruit#5054 from jepler/rmatrix

dhalbert · web-flow · commit 84ddb17c7885 · 2021-07-27T15:05:47.000-04:00
docs: Add list of supported board to each module's page
diff --git a/conf.py b/conf.py
@@ -24,6 +24,7 @@
 import sys
 import urllib.parse
 import time
+from collections import defaultdict
 
 from sphinx.transforms import SphinxTransform
 from docutils import nodes
@@ -47,9 +48,15 @@
 
 #modules_support_matrix = shared_bindings_matrix.support_matrix_excluded_boards()
 modules_support_matrix = shared_bindings_matrix.support_matrix_by_board()
+modules_support_matrix_reverse = defaultdict(list)
+for board, modules in modules_support_matrix.items():
+    for module in modules:
+        modules_support_matrix_reverse[module].append(board)
+modules_support_matrix_reverse = dict((module, sorted(boards)) for module, boards in modules_support_matrix_reverse.items())
 
 html_context = {
-    'support_matrix': modules_support_matrix
+    'support_matrix': modules_support_matrix,
+    'support_matrix_reverse': modules_support_matrix_reverse
 }
 
 # -- General configuration ------------------------------------------------
@@ -94,6 +101,8 @@
 autoapi_python_class_content = "both"
 autoapi_python_use_implicit_namespaces = True
 autoapi_root = "shared-bindings"
+def autoapi_prepare_jinja_env(jinja_env):
+    jinja_env.globals['support_matrix_reverse'] = modules_support_matrix_reverse
 
 redirects_file = 'docs/redirects.txt'
 
diff --git a/docs/autoapi/templates/python/module.rst b/docs/autoapi/templates/python/module.rst
@@ -14,6 +14,22 @@
 
 {% endif %}
 
+{% if support_matrix_reverse[obj.name] is defined %}
+.. raw:: html
+
+    <p>
+    <details>
+    <summary>Available on these boards</summary>
+    <ul>
+    {% for board in support_matrix_reverse[obj.name] %}
+    <li> {{ board }}
+    {% endfor %}
+    </ul>
+    </details>
+    </p>
+
+{% endif %}
+
 {% block subpackages %}
 {% set visible_subpackages = obj.subpackages|selectattr("display")|list %}
 {% if visible_subpackages %}
