Merge pull request #91 from adamtheturtle/admonition-colours

Give admonitions background colours

Author: adamtheturtle

src/sphinx_notion/__init__.py

@@ -42,7 +42,7 @@
 )
 from ultimate_notion.core import NotionObject
 from ultimate_notion.obj_api.core import GenericObject
-from ultimate_notion.obj_api.enums import CodeLang, Color
+from ultimate_notion.obj_api.enums import BGColor, CodeLang
 from ultimate_notion.rich_text import Text, text
 
 
@@ -321,14 +321,16 @@ def _create_admonition_callout(
     node: nodes.Element,
     *,
     emoji: str,
-    color: Color,
+    background_color: BGColor,
 ) -> list[NotionObject[Any]]:
     """Create a Notion Callout block for admonition nodes.
 
     The first child (typically a paragraph) becomes the callout text,
     and any remaining children become nested blocks within the callout.
     """
-    block = UnoCallout(text="", icon=Emoji(emoji=emoji), color=color)
+    block = UnoCallout(
+        text="", icon=Emoji(emoji=emoji), color=background_color
+    )
 
     # Use the first child as the callout text
     first_child = node.children[0]
@@ -365,7 +367,11 @@ def _(node: nodes.note, *, section_level: int) -> list[NotionObject[Any]]:
     Process note admonition nodes by creating Notion Callout blocks.
     """
     del section_level
-    return _create_admonition_callout(node=node, emoji="📝", color=Color.BLUE)
+    return _create_admonition_callout(
+        node=node,
+        emoji="📝",
+        background_color=BGColor.BLUE,
+    )
 
 
 @_process_node_to_blocks.register
@@ -374,7 +380,11 @@ def _(node: nodes.warning, *, section_level: int) -> list[NotionObject[Any]]:
     Process warning admonition nodes by creating Notion Callout blocks.
     """
     del section_level
-    return _create_admonition_callout(node=node, emoji="⚠️", color=Color.YELLOW)
+    return _create_admonition_callout(
+        node=node,
+        emoji="⚠️",
+        background_color=BGColor.YELLOW,
+    )
 
 
 @_process_node_to_blocks.register
@@ -383,7 +393,11 @@ def _(node: nodes.tip, *, section_level: int) -> list[NotionObject[Any]]:
     Process tip admonition nodes by creating Notion Callout blocks.
     """
     del section_level
-    return _create_admonition_callout(node=node, emoji="💡", color=Color.GREEN)
+    return _create_admonition_callout(
+        node=node,
+        emoji="💡",
+        background_color=BGColor.GREEN,
+    )
 
 
 @_process_node_to_blocks.register

tests/test_integration.py

@@ -38,7 +38,7 @@
 )
 from ultimate_notion.core import NotionObject
 from ultimate_notion.obj_api.core import GenericObject
-from ultimate_notion.obj_api.enums import CodeLang, Color
+from ultimate_notion.obj_api.enums import BGColor, CodeLang
 from ultimate_notion.rich_text import text
 
 
@@ -741,18 +741,18 @@ def test_bullet_list_with_inline_formatting(
 
 
 @pytest.mark.parametrize(
-    argnames=("admonition_type", "emoji", "color", "message"),
+    argnames=("admonition_type", "emoji", "background_color", "message"),
     argvalues=[
-        ("note", "📝", Color.BLUE, "This is an important note."),
-        ("warning", "⚠️", Color.YELLOW, "This is a warning message."),
-        ("tip", "💡", Color.GREEN, "This is a helpful tip."),
+        ("note", "📝", BGColor.BLUE, "This is an important note."),
+        ("warning", "⚠️", BGColor.YELLOW, "This is a warning message."),
+        ("tip", "💡", BGColor.GREEN, "This is a helpful tip."),
     ],
 )
 def test_admonition_single_line(
     *,
     admonition_type: str,
     emoji: str,
-    color: Color,
+    background_color: BGColor,
     message: str,
     make_app: Callable[..., SphinxTestApp],
     tmp_path: Path,
@@ -771,7 +771,7 @@ def test_admonition_single_line(
     callout = UnoCallout(
         text=message,
         icon=Emoji(emoji=emoji),
-        color=color,
+        color=background_color,
     )
 
     expected_objects: list[NotionObject[Any]] = [
@@ -788,17 +788,17 @@ def test_admonition_single_line(
 
 
 @pytest.mark.parametrize(
-    argnames=("admonition_type", "emoji", "color"),
+    argnames=("admonition_type", "emoji", "background_color"),
     argvalues=[
-        ("note", "📝", Color.BLUE),
-        ("warning", "⚠️", Color.YELLOW),
-        ("tip", "💡", Color.GREEN),
+        ("note", "📝", BGColor.BLUE),
+        ("warning", "⚠️", BGColor.YELLOW),
+        ("tip", "💡", BGColor.GREEN),
     ],
 )
 def test_admonition_multiline(
     admonition_type: str,
     emoji: str,
-    color: Color,
+    background_color: BGColor,
     make_app: Callable[..., SphinxTestApp],
     tmp_path: Path,
 ) -> None:
@@ -813,7 +813,11 @@ def test_admonition_multiline(
 
            This is the second paragraph that should be nested.
     """
-    callout = UnoCallout(text="", icon=Emoji(emoji=emoji), color=color)
+    callout = UnoCallout(
+        text="",
+        icon=Emoji(emoji=emoji),
+        color=background_color,
+    )
     callout.rich_text = text(
         text=f"This is the first paragraph of the {admonition_type}."
     )
@@ -854,7 +858,7 @@ def hello():
            The code above demonstrates a simple function.
     """
 
-    callout = UnoCallout(text="", icon=Emoji(emoji="📝"), color=Color.BLUE)
+    callout = UnoCallout(text="", icon=Emoji(emoji="📝"), color=BGColor.BLUE)
     callout.rich_text = text(text="This note contains a code example.")
 
     nested_code_block = _create_code_block_without_annotations(
@@ -898,7 +902,7 @@ def hello():
            This paragraph comes after the code block.
     """
 
-    callout = UnoCallout(text="", icon=Emoji(emoji="📝"), color=Color.BLUE)
+    callout = UnoCallout(text="", icon=Emoji(emoji="📝"), color=BGColor.BLUE)
     callout.rich_text = text(text="")
 
     nested_code_block = _create_code_block_without_annotations(
@@ -938,7 +942,7 @@ def test_admonition_with_bullet_points(
            * B
     """
 
-    callout = UnoCallout(text="", icon=Emoji(emoji="📝"), color=Color.BLUE)
+    callout = UnoCallout(text="", icon=Emoji(emoji="📝"), color=BGColor.BLUE)
     callout.rich_text = text(
         text="This is an important note that demonstrates the note "
         "admonition\nsupport."