Merge pull request #298 from adamtheturtle/kbd

Add support for the :kbd: role

Author: adamtheturtle

sample/index.rst

@@ -35,6 +35,11 @@ Other Text Styles
 
 The builder supports additional text styles: :text-bold:`bold text`, :text-italic:`italic text`, :text-mono:`monospace text`, :text-strike:`strikethrough text`, and :text-underline:`underlined text`.
 
+Keyboard Shortcuts
+~~~~~~~~~~~~~~~~~~
+
+The builder supports keyboard shortcuts using the standard ``:kbd:`` role: Press :kbd:`Ctrl+C` to copy, :kbd:`Ctrl+V` to paste, and :kbd:`Ctrl+Z` to undo.
+
 .. note::
 
    This is an important note that demonstrates the note admonition support.

src/sphinx_notion/__init__.py

@@ -349,7 +349,11 @@ def _create_styled_text_from_node(*, child: nodes.Element) -> Text:
 
     is_bold = isinstance(child, nodes.strong) or "text-bold" in classes
     is_italic = isinstance(child, nodes.emphasis) or "text-italic" in classes
-    is_code = isinstance(child, nodes.literal) or "text-mono" in classes
+    is_code = (
+        isinstance(child, nodes.literal)
+        or "text-mono" in classes
+        or "kbd" in classes
+    )
     is_strikethrough = (
         isinstance(child, strike_node) or "text-strike" in classes
     )
@@ -361,6 +365,7 @@ def _create_styled_text_from_node(*, child: nodes.Element) -> Text:
         "text-mono",
         "text-strike",
         "text-underline",
+        "kbd",
         *color_mapping.keys(),
         *bg_color_classes,
     }

tests/test_integration.py

@@ -2747,6 +2747,54 @@ def test_inline_single_backticks(
     )
 
 
+def test_kbd_role(
+    *,
+    make_app: Callable[..., SphinxTestApp],
+    tmp_path: Path,
+) -> None:
+    """The ``:kbd:`` role creates keyboard input formatting.
+
+    The ``:kbd:`` role splits keyboard shortcuts into separate segments,
+    where each key is formatted as code but the + separator is not.
+    """
+    rst_content = """
+        Press :kbd:`Ctrl+C` to copy and :kbd:`Ctrl+V` to paste.
+    """
+
+    normal_text1 = text(text="Press ")
+    kbd_text1 = text(text="Ctrl", code=True)
+    plus_text1 = text(text="+", code=False)
+    kbd_text2 = text(text="C", code=True)
+    normal_text2 = text(text=" to copy and ")
+    kbd_text3 = text(text="Ctrl", code=True)
+    plus_text2 = text(text="+", code=False)
+    kbd_text4 = text(text="V", code=True)
+    normal_text3 = text(text=" to paste.")
+
+    combined_text = (
+        normal_text1
+        + kbd_text1
+        + plus_text1
+        + kbd_text2
+        + normal_text2
+        + kbd_text3
+        + plus_text2
+        + kbd_text4
+        + normal_text3
+    )
+
+    expected_paragraph = UnoParagraph(text=combined_text)
+
+    expected_objects: list[Block] = [expected_paragraph]
+
+    _assert_rst_converts_to_notion_objects(
+        rst_content=rst_content,
+        expected_objects=expected_objects,
+        make_app=make_app,
+        tmp_path=tmp_path,
+    )
+
+
 def test_unsupported_node_types_in_rich_text(
     *,
     make_app: Callable[..., SphinxTestApp],