Merge pull request #358 from adamtheturtle/file

Support the :file: role

Author: adamtheturtle

sample/index.rst

@@ -35,6 +35,8 @@ Text Formatting
 
    The builder supports keyboard shortcuts using the standard ``:kbd:`` role: Press :kbd:`Ctrl+C` to copy, :kbd:`Ctrl+V` to paste.
 
+   The builder supports file paths using the standard ``:file:`` role: Edit the :file:`config.py` file or check :file:`/etc/hosts`.
+
 Admonitions
 ~~~~~~~~~~~
 

src/sphinx_notion/__init__.py

@@ -366,6 +366,7 @@ def _create_styled_text_from_node(*, node: nodes.Element) -> Text:
         isinstance(node, nodes.literal)
         or "text-mono" in classes
         or "kbd" in classes
+        or "file" in classes
     )
     is_strikethrough = (
         isinstance(node, strike_node) or "text-strike" in classes
@@ -379,6 +380,7 @@ def _create_styled_text_from_node(*, node: nodes.Element) -> Text:
         "text-strike",
         "text-underline",
         "kbd",
+        "file",
         *color_mapping.keys(),
         *bg_color_classes,
     }

tests/test_integration.py

@@ -2847,6 +2847,37 @@ def test_kbd_role(
     )
 
 
+def test_file_role(
+    *,
+    make_app: Callable[..., SphinxTestApp],
+    tmp_path: Path,
+) -> None:
+    """The ``:file:`` role creates file path formatting.
+
+    File paths should be rendered as inline code.
+    """
+    rst_content = """
+        Edit the :file:`config.py` file.
+    """
+
+    normal_text1 = text(text="Edit the ")
+    file_text = text(text="config.py", code=True)
+    normal_text2 = text(text=" file.")
+
+    combined_text = normal_text1 + file_text + normal_text2
+
+    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],