Merge pull request #268 from Holzhaus/fix-hwlabel-ampersand

sphinx-mixxx: Fix usage of ampersand in hwlabel role
mixxxdj · Oct 30, 2020 · 1050b2e · 1050b2e
2 parents aa9aa1d + 5f7cbb9
commit 1050b2e
Showing 1 changed file with 10 additions and 2 deletions.
diff --git a/sphinx-mixxx/sphinx_mixxx/roles.py b/sphinx-mixxx/sphinx_mixxx/roles.py
@@ -1,9 +1,17 @@
-from sphinx.roles import GUILabel
+from typing import List, Tuple
 
+from docutils import nodes
+from sphinx.roles import SphinxRole
 
-class HWLabel(GUILabel):
+
+class HWLabel(SphinxRole):
     """Label on external hardware (such as controllers)."""
 
+    def run(self) -> Tuple[List[nodes.Node], List[nodes.system_message]]:
+        node = nodes.inline(rawtext=self.rawtext, classes=[self.name])
+        node += nodes.Text(self.text)
+        return [node], []
+
 
 specific_docroles = {
     "hwlabel": HWLabel(),